Coderabbit Docs Rework (wip)

coderabbitai · tyaga001 · Oct 17, 2024 · Dec 21, 2023 · Dec 21, 2023 · Dec 22, 2023
commit 185056037d59c278f428e7c121cf23e3e1ba29ea
diff --git a/blog/2019-05-28-first-blog-post.md b/blog/2019-05-28-first-blog-post.md
@@ -0,0 +1,12 @@
+---
+slug: first-blog-post
+title: First Blog Post
+authors:
+  name: Gao Wei
+  title: Docusaurus Core Team
+  url: https://github.com/wgao19
+  image_url: https://github.com/wgao19.png
+tags: [hola, docusaurus]
+---
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
diff --git a/blog/2019-05-29-long-blog-post.md b/blog/2019-05-29-long-blog-post.md
@@ -0,0 +1,44 @@
+---
+slug: long-blog-post
+title: Long Blog Post
+authors: endi
+tags: [hello, docusaurus]
+---
+
+This is the summary of a very long blog post,
+
+Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
+
+<!--truncate-->
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
diff --git a/blog/2021-08-01-mdx-blog-post.mdx b/blog/2021-08-01-mdx-blog-post.mdx
@@ -0,0 +1,20 @@
+---
+slug: mdx-blog-post
+title: MDX Blog Post
+authors: [slorber]
+tags: [docusaurus]
+---
+
+Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
+
+:::tip
+
+Use the power of React to create interactive blog posts.
+
+```js
+<button onClick={() => alert('button clicked!')}>Click me!</button>
+```
+
+<button onClick={() => alert('button clicked!')}>Click me!</button>
+
+:::
diff --git a/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg
diff --git a/blog/2021-08-26-welcome/index.md b/blog/2021-08-26-welcome/index.md
@@ -0,0 +1,25 @@
+---
+slug: welcome
+title: Welcome
+authors: [slorber, yangshun]
+tags: [facebook, hello, docusaurus]
+---
+
+[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
+
+Simply add Markdown files (or folders) to the `blog` directory.
+
+Regular blog authors can be added to `authors.yml`.
+
+The blog post date can be extracted from filenames, such as:
+
+- `2019-05-30-welcome.md`
+- `2019-05-30-welcome/index.md`
+
+A blog post folder can be convenient to co-locate blog post images:
+
+![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)
+
+The blog supports tags as well!
+
+**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.
diff --git a/docs/about.md b/docs/about.md
@@ -0,0 +1,52 @@
+---
+id: introduction
+title: What is CodeRabbit?
+sidebar_label: What is CodeRabbit?
+---
+
+<head>
+ <meta charSet="utf-8" />
+  <meta name="title" content="CodeRabbit: AI-powered Code Reviews" />
+  <meta name="description" content="Accelerate Code Reviews with AI" />
+
+  <meta property="og:type" content="website" />
+  <meta property="og:url" content="https://coderabbit.ai/" />
+  <meta property="og:title" content="CodeRabbit: AI-powered Code Reviews" />
+  <meta property="og:description" content="Accelerate Code Reviews with AI" />
+  <meta property="og:image" content="/preview_meta.jpg" />
+
+  <meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" />
+  <meta name="twitter:card" content="summary_large_image" />
+  <meta name="twitter:title" content="CodeRabbit: AI-powered Code Reviews" />
+  <meta name="twitter:description" content="Accelerate Code Reviews with AI." />
+</head>
+
+**CodeRabbit** is an innovative, AI-first code reviewer. It provides context aware review feedback on a pull request within minutes, thereby significantly reducing the time and effort associated with manual code reviews. Secondly, it brings a different perspective to the reviews and finds issues often missed by the human eye. Developers can chat with the bot within the code, which allows them to provide additional context, ask questions, or have the bot generate code. It learns from your suggestions and gets better overtime.
+
+**CodeRabbit** seamlessly integrates with GitHub and GitLab repositories, performing continuous, incremental reviews for each commit within a pull request. Review feedback is sent back to the pull requests and can be directly committed.
+
+### How does CodeRabbit work?
+
+**CodeRabbit** integrates into code repositories using GitHub or GitLab webhooks and monitors events related to Pull Request (PR) and Merge Request (MR) changes. A comprehensive review is performed when a PR or MR is created, and for incremental commits and comments addressed to the bot. The feedback is then sent directly back to the PR or MR.
+
+![](./introduction/images/CodeRabbitFlow.png)
+
+### Data, Privacy, and Security.
+
+**CodeRabbit** does not use data collected during code reviews to train or influence the models. Queries to the Large Language Model (LLM) are ephemeral. Neither we nor the LLM we use share any data collected during the code review process with other third parties.
+
+Does CodeRabbit store my Data? We store embeddings of your conversations, which are used to improve future reviews.
+
+Compliance and Data Privacy: Your data is kept confidential, isolated, and used only to improve your reviews. Data storage complies with SOC2 Type II, GDPR, and HIPAA standards.
+
+Opting Out: You can choose to opt out of data storage at any time. Opting out won't affect your access but will limit the personalization of the reviews.
+
+### Do you need CodeRabbit with the AI code generators or co-pilot?
+
+Code reviews remain essential, whether the code is written by a human or a bot. This is mainly because the perspective of the reviewer differs from that of the code generator, whether human or machine. This distinction is precisely why human peer reviews have been effective for so long. While AI-powered code-generation tools hold immense potential, it's important to recognize that these generators are still in their early stages and may not be equipped to auto-generate meaningful code for moderately complex applications.
+
+### How is CodeRabbit different from existing code review tools?
+
+Existing code review tools are good at linting and static code analysis; however, they lack context-aware, human-like review feedback.
+
+For information on how to get started with **CodeRabbit**, please visit the [Get Started page](https://coderabbit.ai/docs/get-started/signup).
diff --git a/docs/changelog/changelogs.md b/docs/changelog/changelogs.md
@@ -0,0 +1,136 @@
+---
+title: Changelog
+id: changelog
+slug: /changelog
+description: Accelerate Code Reviews with AI
+image: "/preview_meta.jpg"
+---
+<head>
+ <meta charSet="utf-8" />
+  <meta name="title" content="CodeRabbit: AI-powered Code Reviews" />
+  <meta name="description" content="Accelerate Code Reviews with AI" />
+
+  <meta property="og:type" content="website" />
+  <meta property="og:url" content="https://coderabbit.ai/" />
+  <meta property="og:title" content="CodeRabbit: AI-powered Code Reviews" />
+  <meta property="og:description" content="Accelerate Code Reviews with AI" />
+  <meta property="og:image" content="/preview_meta.jpg" />
+
+  <meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" />
+  <meta name="twitter:card" content="summary_large_image" />
+  <meta name="twitter:title" content="CodeRabbit: AI-powered Code Reviews" />
+  <meta name="twitter:description" content="Accelerate Code Reviews with AI" />
+</head>
+
+Learn about the latest updates and bug fixes in CodeRabbit.
+
+Product Updates 
+
+
+## Request Changes Workflow 
+
+**Date: December 18, 2023**
+
+Enable Request Changes review workflow for CodeRabbit reviews via `.coderabbit.yaml` 
+Yaml field `request_changes_workflow`  (default: `false`). When enabled, review comments are posted as request changes and CodeRabbit review will be marked approved once all the review comments are resolved. 
+
+## Learnings 
+
+**Date: December 5, 2023**
+
+CodeRabbit can now learn from your conversations to fine-tune your reviews. If you encounter inaccurate feedback or something not relevant to your codebase, just let the bot know, and it will remember the context for the future. We understand that coding practices and standards evolve over time. Using the chat, you can inform the bot, and it will remove any existing learnings that are no longer relevant. This feature does not work, if you have opted out of data storage.
+
+![](./images/learnings.png)
+
+## Codebase Verification
+
+**Date: December 5, 2023**
+
+Verifies the reference of the changes on the overall codebase and identifies missing changes. 
+
+
+![](./images/verification.png)
+
+
+##  Jira and Linear Integrations
+
+**Date: December 5, 2023**
+
+ You can now integrate Jira and Linear into CodeRabbit. This would be used for additional context while reviewing pull requests. If you use any of these systems, we recommend you integrate CodeRabbit. We will be adding more integrations over time.
+
+
+## Related Issues
+
+**Date: December 5, 2023**
+
+Identifies all issues affected by the code changes. This helps understand the impact on the overall product. It also assists in identifying duplicate issues or the impact on any other existing issues. This feature does not work, if you have opted out of data.
+
+![](./images/related_issues.png)
+
+## Issue Validation
+
+**Date: November 5, 2023**
+
+- **Issue Validation**:
+  - CodeRabbit review can now assess the pull request changes against the linked GitHub or GitLab issue. Integration with other workflow systems including Jira and Linear is under development. 
+
+![](./images/issue-validation.png)
+
+## Committable suggestions
+
+**Date: November 1, 2023**
+
+- **Code review comments**:
+  - Review comments can now post committable suggestions that can be committed within the pull request with a single click.
+
+![](./images/committable-suggestion.png)
+
+## Resolve Command
+
+**Date: October 28, 2023**
+
+- **Resolve Command**:
+  - Use `@coderabbitai resolve` to mark all the CodeRabbit review comments as resolved all at once.
+
+## CodeRabbit Commands
+
+**Date: October 23, 2023**
+
+Introducing additional CodeRabbit commands for managing code reviews.
+
+- **Pause Reviews**: 
+  - Use `@coderabbitai pause` in a PR comment to halt ongoing reviews.
+- **Resume Reviews**: 
+  - Enter `@coderabbitai resume` in a PR comment to continue paused reviews.
+- **On-Demand Reviews**: 
+  - Disable automatic reviews for your repository to switch to on-demand reviews.
+  - Use `@coderabbitai review` in a PR comment. This command will override all review filters that might be set up in the repository settings and will initiate a one-time review.  
+- **Help Command**:
+  - You can at any time post `@coderabbitai help` in a PR comment to get the list of all valid commands.
+
+
+## Customization CodeRabbit with YML File
+
+![code](./images/ymlrabbit.png)
+
+**Date: October 12, 2023**
+
+
+CodeRabbit customizations made easy!
+You can now customize CodeRabbit using a YML file from your repository. To learn more, refer to our comprehensive [documentation on customizing CodeRabbit](https://coderabbit.ai/docs/get-started/customize-coderabbit).
+
+## Path-Based Review Instructions in CodeRabbit
+
+![code](./images/path.png)
+
+**Date: September 21, 2023**
+
+Introducing  Path-Based Instructions  CodeRabbit reviews now allow setting path-based instructions. This feature is particularly useful if you want reviewers to follow specific guidelines. For example, if you have a mono repo, this enables the setting of custom instructions by directories. It can also be used to set instructions for specific file types. For instance: */.js - ensure that the code adheres to the Google style guide.
+
+[Learn More](https://coderabbit.ai/docs/get-started/prompt-customization)
+
+## Introducing CodeRabbit for GitLab Integration
+
+**Date: September 19, 2023**
+
+CodeRabbit is now available for GitLab! We know many of you have been waiting for this integration. Thank you for your patience. Sign up for the free trial!
diff --git a/docs/changelog/images/committable-suggestion.png b/docs/changelog/images/committable-suggestion.png
diff --git a/docs/changelog/images/issue-validation.png b/docs/changelog/images/issue-validation.png
diff --git a/docs/changelog/images/learnings.png b/docs/changelog/images/learnings.png
diff --git a/docs/changelog/images/path.png b/docs/changelog/images/path.png
diff --git a/docs/changelog/images/related_issues.png b/docs/changelog/images/related_issues.png
diff --git a/docs/changelog/images/verification.png b/docs/changelog/images/verification.png
diff --git a/docs/changelog/images/ymlrabbit.png b/docs/changelog/images/ymlrabbit.png
diff --git a/docs/faq/faq.md b/docs/faq/faq.md
@@ -0,0 +1,81 @@
+---
+title: FAQs
+sidebar_label: FAQs
+description: Accelerate Code Reviews with AI
+image: "/preview_meta.jpg"
+---
+<head>
+ <meta charSet="utf-8" />
+  <meta name="title" content="CodeRabbit: AI-powered Code Reviews" />
+  <meta name="description" content="Accelerate Code Reviews with AI" />
+
+  <meta property="og:type" content="website" />
+  <meta property="og:url" content="https://coderabbit.ai/" />
+  <meta property="og:title" content="CodeRabbit: AI-powered Code Reviews" />
+  <meta property="og:description" content="Accelerate Code Reviews with AI" />
+  <meta property="og:image" content="/preview_meta.jpg" />
+
+  <meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" />
+  <meta name="twitter:card" content="summary_large_image" />
+  <meta name="twitter:title" content="CodeRabbit: AI-powered Code Reviews" />
+  <meta name="twitter:description" content="Accelerate Code Reviews with AI" />
+</head>
+
+#### **1. How accurate is CodeRabbit's review?**
+
+Early adoption results for CodeRabbit have been highly promising, demonstrating significant accuracy in code reviews. However, it's crucial to understand that AI is an evolving field, and absolute 100% accuracy can't be guaranteed. Our technology is continuously learning and improving, aiming for the highest possible accuracy in reviews.
+
+#### **2. Which programming languages does CodeRabbit support?**
+
+CodeRabbit is designed to work with all programming languages. However, the proficiency of our AI models might vary between languages, which could slightly affect the accuracy of the review.
+
+#### **3. Does CodeRabbit store my code or use it for training language models?**
+
+We train our system using open source projects. For private repositories, neither CodeRabbit nor OpenAI LLMs use your code for training purposes.
+
+#### **4. What Large Language Models does CodeRabbit use?**
+
+CodeRabbit currently utilizes Open AI's GPT 4 and GPT 3.5. We're researching and testing upcoming LLMs to ensure we're offering the most precise reviews possible. 
+
+#### **5. Can I customize CodeRabbit?**
+
+Reviews are customizable. For information, check out our [Get Started page](https://coderabbit.ai/docs/get-started/customize-coderabbit).
+
+#### **6. Can I choose a language other than English for the reviews?**
+
+CodeRabbit supports most widely-used languages. You can configure this in the repository settings.
+
+#### **7. What access does CodeRabbit need to my repositories?**
+
+CodeRabbit requests minimal access to perform code reviews and post comments on Pull Requests. On GitHub, it requires read access to metadata, code, discussions, issues, and read/write access to the pull requests. On GitLab, it requires read access to the repository, and the CodeRabbit Bot user requires a developer role.
+
+#### **8. How can I add or remove users for my subscription?**
+
+To manage users, log in to CodeRabbit and navigate to subscriptions. You can add or remove users as needed.
+
+#### **9. How can I interact with the CodeRabbit bot?**
+
+To interact with CodeRabbit's bot, reply to the CodeRabbit Comment. If there are team members collaborating on pull requests, the bot stays silent by default but can be engaged by tagging **@Coderabbitai**. This feature allows you to provide context, generate test cases, or ask for specific code suggestions, all within the context of your code lines or entire files. 
+
+#### **10. Can individual developers use CodeRabbit?**
+
+Absolutely! Whether you're an individual developer or part of an organization, CodeRabbit can be your coding assistant, providing you with invaluable suggestions.
+
+#### **11. Which branches are the pull requests reviewed on?**
+CodeRabbit reviews pull requests on the default branch.
+
+#### **12. Is it possible for CodeRabbit to include additional branches for review?**
+Yes, you can change it under the repository settings.
+
+#### **13. CodeRabbit Usage Limits**
+
+There are hourly rate limits for each developer per repository:
+- Number of files reviewed per hour: 100 Files
+- Number of reviews per hour (includes incremental reviews): 9
+- Number of conversations per hour: 50
+
+In-trial and open-source plans have lower rate limits than the paid plan. In all cases, we re-allow further reviews/conversations after a brief timeout.
+
+Please note that we're continually innovating and enhancing our application with new capabilities. Stay tuned and follow us for updates as new exciting features are built. We're committed to making your experience with CodeRabbit even better.
+
+If you have further questions or need additional information, don't hesitate to reach out to us at [[email protected]](mailto:[email protected]).