diff --git a/docs/about/_category_.yml b/docs/about/_category_.yml new file mode 100644 index 00000000..3d744c15 --- /dev/null +++ b/docs/about/_category_.yml @@ -0,0 +1,4 @@ +label: About +position: 2 +collapsible: true +collapsed: true diff --git a/docs/about/features.md b/docs/about/features.md index 7eb70203..9959e553 100644 --- a/docs/about/features.md +++ b/docs/about/features.md @@ -1,6 +1,6 @@ --- -title: CodeRabbit in Action -sidebar_label: CodeRabbit in Action +title: High-level Features +sidebar_label: High-level Features description: Learn how CodeRabbit works in a pull request review. --- @@ -23,13 +23,19 @@ changes. ### 2. Code Review feedback {#code-review-feedback} -Review comments: Review feedback posts as pull request, review comments on the -lines of the code that changed under each file. Any code suggestions are given -in a Diff format, which either be copied or committed within the pull request -with a single click. +Review feedback is posted as review comments on the lines of the code that +changed for each file. Code suggestions are given in a Diff format, which either +be copied or committed within the pull request with a single click. ![Review Feedback](./images/ReviewFeedback.png) +A review status is generated for each commit that is reviewed. It displays the +commit IDs that were reviewed, the files examined and ignored, as well as the +additional comments generated for each review, and so on. Review status is +useful for understanding the auxiliary context of the review. + +![Review Status](./images/ReviewStatus.png) + ### 3. Chat with CodeRabbit {#chat-with-coderabbit} CodeRabbit provides conversational capability that allows developers and the @@ -46,15 +52,3 @@ Pull request changes are validated against the linked GitHub or GitLab issue and identifies all other issues which might be affected by this change. ![Issue Validation](./images/issue-validation.png) - -### 5. Pull Request review status {#pull-request-review-status} - -Review status is generated for each review, including a separate one for each -incremental commit. Displays the commit IDs that were reviewed, the files -examined and ignored, as well as the actionable feedback and additional comments -generated for each review. - -![Review Status](./images/ReviewStatus.png) - -For information on how to get started with CodeRabbit, visit -the [Get Started page](/get-started/signup) diff --git a/docs/about/pricing.md b/docs/about/pricing.md index b63a5a88..6eccb4f4 100644 --- a/docs/about/pricing.md +++ b/docs/about/pricing.md @@ -1,6 +1,6 @@ --- -title: Plans -sidebar_label: Plans +title: Pricing Plans +sidebar_label: Pricing Plans description: Learn about the plans, pricing, and subscription management of CodeRabbit. --- @@ -92,5 +92,6 @@ These are the hourly usage limits for each developer per repository: ![Free Seat Assignment](./images/cr_seat_free_dark.png#gh-dark-mode-only) ![Free Seat Assignment](./images/cr_seat_free_light.png#gh-light-mode-only) - -**Note:** The subscription is limited to human users; bot users are not supported. Thus, pull requests or merge requests created by bots will not be reviewed. +**Note:** The subscription is limited to human users; bot users are not +supported. Thus, pull requests or merge requests created by bots will not be +reviewed. diff --git a/docs/about/support.md b/docs/about/support.md index 0fa03833..5a4bad40 100644 --- a/docs/about/support.md +++ b/docs/about/support.md @@ -4,57 +4,16 @@ sidebar_label: Support description: Get help with CodeRabbit and find answers to common questions. --- -Welcome to CodeRabbit's Support! Please refer to this section if you encounter -any issues or have questions. Our support team will respond back as soon as +Welcome to CodeRabbit Support! Please refer to the following sections for +contacting our support team. Our support team will respond back as soon as possible. -### **Common Issues and Answers** +## Community Discord -These are the most common questions our support team receives, and you might -find an answer here +For real-time support and to connect with other CodeRabbit users, join our +[Discord](http://discord.gg/GsXnASn26c). -### Can I switch between different organizations on CodeRabbit? - -Yes, you can switch between different organizations on CodeRabbit. To do so, -click on the organization name in the top-right corner of the CodeRabbit UI. - -![Switch Organizations](./images/cr_support_orgs_light.png#gh-light-mode-only) -![Switch Organizations](./images/cr_support_orgs_dark.png#gh-dark-mode-only) - -### Can CodeRabbit subscription be used across multiple organizations? - -Subscription seats are tied to the specific GitHub/GitLab organization under -which they are purchased and cannot be used under another organization. - -### Can CodeRabbit review my existing PRs after integrating it? - -CodeRabbit would by default only review new PRs or existing PRs which have a new -commit after the app is installed. You can, however, use the -`@coderabbitai review` command on the PR to trigger a review of existing PRs. - -### Who can add the repositories on CodeRabbit? - -You need to be a GitHub/GitLab admin to add the repositories. - -### Do I need my own OpenAI key with CodeRabbit Pro? - -OpenAI cost is part of the subscription. There is no additional cost for OpenAI. - -### What is the difference between CodeRabbit OSS and CodeRabbit Pro? - -[`ai-pr-reviewer`](https://github.com/coderabbitai/ai-pr-reviewer) project is -our Open-Source Software (OSS) for pull request reviews. With CodeRabbit OSS, -you need your own OpenAI key, and you will incur OpenAI costs. On the other -hand, with a CodeRabbit Pro subscription, the OpenAI cost is included. -Additionally, CodeRabbit Pro offers advanced prompts and superior noise -reduction features, which are not present in CodeRabbit OSS. - -### Can I use both CodeRabbit OSS and CodeRabbit Pro together? - -You can, but this will result in duplicate reviews. We suggest you use only one -of the two. - -### **Opening a Support Ticket** +## Support Tickets To get assistance from our support team, open a ticket using the help icon on the CodeRabbit UI: @@ -66,13 +25,15 @@ provide the GitHub or GitLab organization name. ![Open a Ticket](./images/cr_support_help_light.png#gh-light-mode-only) ![Open a Ticket](./images/cr_support_help_dark.png#gh-dark-mode-only) -:::tip +## Email Support -To see more common issues faced by CodeRabbit users, visit our FAQ section for -detailed answers and solutions to frequently encountered problems. +You can also reach out to us at +[contact@coderabbit.ai](mailto:contact@coderabbit.ai). -::: +:::tip -### **Community Collaboration** +To see more common issues faced by CodeRabbit users, visit our +[FAQ section](../faq/faq.md) for detailed answers and solutions to frequently +encountered problems. -Consider joining the CodeRabbit community on Discord. +::: diff --git a/docs/faq/faq.md b/docs/faq/faq.md index 7a3f80d1..b8741a03 100644 --- a/docs/faq/faq.md +++ b/docs/faq/faq.md @@ -4,46 +4,77 @@ sidebar_label: FAQs description: Frequently asked questions about CodeRabbit. --- -#### **1. How accurate is CodeRabbit's review?** +#### 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. +technology is continuously improving, aiming for the highest possible accuracy +in reviews. -#### **2. Which programming languages does CodeRabbit support?** +#### 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. +proficiency of our AI models might vary between languages based on their +popularity and the public availability of training data. -#### **3. Does CodeRabbit store my code ?** +#### Does CodeRabbit store my code? -We do not store any source code. The code collected at the time of the review is disposed of as soon as the review is complete. During the review, there is complete data isolation for the code being reviewed, and no one from CodeRabbit or outside has access to the code. +We do not store your code. The code collected at the time of the review is +disposed off as soon as the review is complete. During the review, there is +complete data isolation of the code being reviewed, and no one from CodeRabbit +or outside has access to the code. -#### **4. Does CodeRabbit use my proprietary code for training language models?** +#### Does CodeRabbit use my proprietary code for training language models? -We train our system only using open source projects. CodeRabbit never uses the proprietary -code on private repositories for training purposes. +We train our system only using publicly available datasets. CodeRabbit never +uses the proprietary code from private repositories for training purposes. -#### **5. What Large Language Models does CodeRabbit use?** +#### Can I switch between different organizations on CodeRabbit? + +Yes, you can switch between different organizations on CodeRabbit. To do so, +click on the organization name in the top-right corner of the CodeRabbit UI. + +![Switch Organizations](./images/cr_support_orgs_light.png#gh-light-mode-only) +![Switch Organizations](./images/cr_support_orgs_dark.png#gh-dark-mode-only) + +#### Can CodeRabbit subscription be used across multiple organizations? + +Subscription seats are tied to the specific GitHub/GitLab organization under +which they are purchased and cannot be used under another organization. + +#### Can CodeRabbit review my existing PRs after integrating it? + +CodeRabbit would by default only review new PRs or existing PRs which have a new +commit after the app is installed. You can, however, use the +`@coderabbitai review` command on the PR to trigger a review of existing PRs. + +#### Who can add the repositories on CodeRabbit? + +You need to be a GitHub/GitLab admin to add the repositories. + +#### Do I need my own OpenAI key with CodeRabbit Pro? + +OpenAI cost is included as part of the subscription. You don't need to have your +own OpenAI key. + +#### What Large Language Models does CodeRabbit use? CodeRabbit currently utilizes OpenAI's `gpt-4-turbo` and `gpt-3.5-turbo`. We're researching and testing upcoming LLMs to ensure we're offering the most precise reviews possible. -#### **6. Can I customize CodeRabbit?** +#### Can I customize CodeRabbit? Reviews are customizable. For information, check out our -[Get Started page](../get-started/signup.md). +[Customization](../guides/review-instructions.md) guide. -#### **7. Can I choose a language other than English for the reviews?** +#### 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. -#### **8. What access does CodeRabbit need to my repositories?** +#### 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, @@ -51,34 +82,31 @@ 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. -#### **9. How can I add or remove users for my subscription?** +#### 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. -#### **10. How can I interact with the CodeRabbit bot?** +#### 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 +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. -#### **11. Can individual developers use CodeRabbit?** +#### 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. -#### **12. Which branches are the pull requests reviewed on?** +#### Which branches are the pull requests reviewed on? -CodeRabbit reviews pull requests on the default branch. +CodeRabbit reviews pull requests on the default branch by default. You can +change this in the repository settings. -#### **13. Is it possible for CodeRabbit to include additional branches for review?** - -Yes, you can change it under the repository settings. - -#### **14. CodeRabbit Usage Limits** +#### CodeRabbit Usage Limits There are hourly rate limits for each developer per repository: @@ -89,18 +117,14 @@ There are hourly rate limits for each developer per repository: 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. -#### **15. I can't add CodeRabbit to my GitLab Repositories?** +#### I can't add CodeRabbit to my GitLab Repositories. What should I do? If there are any access restrictions by domain, then you will need to add `coderabbit.ai` as an allowed domain. -:::note +:::tip -We are 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, please check out +our [Support](../about/support.md) page for more details. ::: - -If you have further questions or need additional information, don't hesitate to -reach out to us at [contact@coderabbit.ai](mailto:contact@coderabbit.ai). diff --git a/docs/about/images/cr_support_orgs_dark.png b/docs/faq/images/cr_support_orgs_dark.png similarity index 100% rename from docs/about/images/cr_support_orgs_dark.png rename to docs/faq/images/cr_support_orgs_dark.png diff --git a/docs/about/images/cr_support_orgs_light.png b/docs/faq/images/cr_support_orgs_light.png similarity index 100% rename from docs/about/images/cr_support_orgs_light.png rename to docs/faq/images/cr_support_orgs_light.png diff --git a/docs/get-started/add-repo.md b/docs/get-started/add-repo.md deleted file mode 100644 index 59d8ec53..00000000 --- a/docs/get-started/add-repo.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Add Repositories -sidebar_label: Add Repositories -description: Learn how to add CodeRabbit to your GitHub or GitLab repositories. ---- - -Learn how to add CodeRabbit to your GitHub or GitLab repositories. - -To add additional repositories after the sign-up, go to the repositories page -within the CodeRabbit UI. - -Click on the "**Add repositories**" button. Upon clicking, you'll be redirected -to GitHub. - -![AddRepo](./images/cr_add_repo_light.png#gh-light-mode-only) -![AddRepo](./images/cr_add_repo_dark.png#gh-dark-mode-only) - -Upon successful installation, you will be automatically redirected back to the -CodeRabbit UI. Here, you can view the list of repositories that CodeRabbit now -has access to. - -:::note - -For **GitLab**, the flow is slightly different. All the repositories display by -default, and you can toggle and enable the ones where the CodeRabbit app should -be installed. - -![AddRepo](./images/cr_add_repo_gitlab_light.png#gh-light-mode-only) -![AddRepo](./images/cr_add_repo_gitlab_dark.png#gh-dark-mode-only) - -::: - -### **Need help?** - -If you require assistance, our support team is here to help. Simply click on the -help icon within the CodeRabbit user interface. For more detailed information, -please refer to the "Support" section. Additionally, consider joining the -CodeRabbit **Discord** community to connect with other users and access a wealth -of knowledge about using CodeRabbit effectively. diff --git a/docs/get-started/analytics.md b/docs/get-started/analytics.md deleted file mode 100644 index c9e847c6..00000000 --- a/docs/get-started/analytics.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: CodeRabbit Dashboard -sidebar_label: CodeRabbit Dashboard -description: - CodeRabbit Dashboard displays organization's pull request activity and value - provided by CodeRabbit reviews. -slug: /dashboard ---- - -CodeRabbit Dashboard displays organization's pull request activity and value -provided by CodeRabbit reviews. This includes the number of pull requests -reviewed, actionable items, optional comments and more. - -The dashboard displays the following information: - -- **Pull Requests Overview:** View the number of pull requests reviewed by - CodeRabbit per week, month, and year. -- **CodeRabbit's Activity:** Understand the metrics related to the number of - reviews conducted by CodeRabbit, actionable items, and optional suggestions. - -![Dashboard](./images/cr_dash_dark.png#gh-dark-mode-only) -![Dashboard](./images/cr_dash_light.png#gh-light-mode-only) - -Access the list of recent pull requests reviewed. - -![History](./images/cr_history_dark.png#gh-dark-mode-only) -![History](./images/cr_history_light.png#gh-light-mode-only) - -### **Need help?** - -If you require assistance, our support team is here to help. Simply click on the -help icon within the CodeRabbit user interface. For more detailed information, -please refer to the "Support" section. Additionally, consider joining the -CodeRabbit Discord community to connect with other users and access a wealth of -knowledge about using CodeRabbit effectively. diff --git a/docs/get-started/images/add2.png b/docs/get-started/images/add2.png deleted file mode 100644 index fd29b5d3..00000000 Binary files a/docs/get-started/images/add2.png and /dev/null differ diff --git a/docs/get-started/images/add3.png b/docs/get-started/images/add3.png deleted file mode 100644 index f577ae12..00000000 Binary files a/docs/get-started/images/add3.png and /dev/null differ diff --git a/docs/get-started/images/committable-suggestion.png b/docs/get-started/images/committable-suggestion.png deleted file mode 100644 index 4b3f6267..00000000 Binary files a/docs/get-started/images/committable-suggestion.png and /dev/null differ diff --git a/docs/get-started/images/cr_add_repo_dark.png b/docs/get-started/images/cr_add_repo_dark.png deleted file mode 100644 index cd86686e..00000000 Binary files a/docs/get-started/images/cr_add_repo_dark.png and /dev/null differ diff --git a/docs/get-started/images/cr_add_repo_gitlab_dark.png b/docs/get-started/images/cr_add_repo_gitlab_dark.png deleted file mode 100644 index 2f5fcf49..00000000 Binary files a/docs/get-started/images/cr_add_repo_gitlab_dark.png and /dev/null differ diff --git a/docs/get-started/images/cr_add_repo_gitlab_light.png b/docs/get-started/images/cr_add_repo_gitlab_light.png deleted file mode 100644 index 9e14c409..00000000 Binary files a/docs/get-started/images/cr_add_repo_gitlab_light.png and /dev/null differ diff --git a/docs/get-started/images/cr_add_repo_light.png b/docs/get-started/images/cr_add_repo_light.png deleted file mode 100644 index 7ce435b8..00000000 Binary files a/docs/get-started/images/cr_add_repo_light.png and /dev/null differ diff --git a/docs/get-started/images/cr_dash_dark.png b/docs/get-started/images/cr_dash_dark.png deleted file mode 100644 index 49962fcc..00000000 Binary files a/docs/get-started/images/cr_dash_dark.png and /dev/null differ diff --git a/docs/get-started/images/cr_dash_light.png b/docs/get-started/images/cr_dash_light.png deleted file mode 100644 index cba70af0..00000000 Binary files a/docs/get-started/images/cr_dash_light.png and /dev/null differ diff --git a/docs/get-started/images/cr_history_dark.png b/docs/get-started/images/cr_history_dark.png deleted file mode 100644 index 40cec0d8..00000000 Binary files a/docs/get-started/images/cr_history_dark.png and /dev/null differ diff --git a/docs/get-started/images/cr_history_light.png b/docs/get-started/images/cr_history_light.png deleted file mode 100644 index 115f8841..00000000 Binary files a/docs/get-started/images/cr_history_light.png and /dev/null differ diff --git a/docs/get-started/images/cr_login.png b/docs/get-started/images/cr_login.png deleted file mode 100644 index dd8f4c6e..00000000 Binary files a/docs/get-started/images/cr_login.png and /dev/null differ diff --git a/docs/get-started/images/cr_login2.png b/docs/get-started/images/cr_login2.png deleted file mode 100644 index 536dc7f2..00000000 Binary files a/docs/get-started/images/cr_login2.png and /dev/null differ diff --git a/docs/get-started/images/cr_login_dark.png b/docs/get-started/images/cr_login_dark.png deleted file mode 100644 index 766ea9e5..00000000 Binary files a/docs/get-started/images/cr_login_dark.png and /dev/null differ diff --git a/docs/get-started/images/issue-validation.png b/docs/get-started/images/issue-validation.png deleted file mode 100644 index 4b21fd70..00000000 Binary files a/docs/get-started/images/issue-validation.png and /dev/null differ diff --git a/docs/get-started/images/related-issues.png b/docs/get-started/images/related-issues.png deleted file mode 100644 index c6d0bd46..00000000 Binary files a/docs/get-started/images/related-issues.png and /dev/null differ diff --git a/docs/get-started/images/tailor2.png b/docs/get-started/images/tailor2.png deleted file mode 100644 index cca46e89..00000000 Binary files a/docs/get-started/images/tailor2.png and /dev/null differ diff --git a/docs/get-started/images/tailor3.png b/docs/get-started/images/tailor3.png deleted file mode 100644 index 9816c87a..00000000 Binary files a/docs/get-started/images/tailor3.png and /dev/null differ diff --git a/docs/get-started/images/ymlrabbit.png b/docs/get-started/images/ymlrabbit.png deleted file mode 100644 index 16ea3a7b..00000000 Binary files a/docs/get-started/images/ymlrabbit.png and /dev/null differ diff --git a/docs/get-started/signup.md b/docs/get-started/signup.md deleted file mode 100644 index edc88622..00000000 --- a/docs/get-started/signup.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Sign Up -sidebar_label: Sign Up -description: - Learn how to sign up for CodeRabbit and get started with your first code - review. ---- - -### **Sign Up for CodeRabbit** - -Signing up for CodeRabbit is quick and easy, allowing you to get started in just -a few seconds. Whether you're an individual developer or part of a team, you can -start for free and upgrade to a paid plan after a no-commitment trial. For more -information about CodeRabbit's subscription plan options, please refer to the -pricing page. - -### **Step 1: Getting Started** - -**Login with GitHub or GitLab**: Log in with your GitHub or GitLab account at -[https://coderabbit.ai/login](https://coderabbit.ai/login) - -![Login](./images/cr_login2.png#gh-light-mode-only) -![Login](./images/cr_login_dark.png#gh-dark-mode-only) - -### **Step 2: Select Organization** - -On the GitHub page, you will be prompted to choose the organization where you -want to install the CodeRabbit app. Select the organization to proceed. - -![Untitled](./images/add2.png) - -### **Step 3: Authorize CodeRabbit** - -After selecting the organization, you will be directed to a GitHub repositories -page where you will install and authorize the CodeRabbit GitHub app. You can -choose to grant access to all your organization's repositories or select -specific repositories. - -![Untitled](./images/add3.png) - -After you have installed the CodeRabbit app, the reviews will start -automatically with the new pull requests or incremental commits to existing pull -requests. To trigger reviews on existing pull requests, post "@coderabbitai -review" as a comment on the pull request. - -:::tip - -The automatic code review behavior can be changed to "On-Demand". To make this -change, go to the repository settings in the UI or modify the appropriate -setting in the YAML file to disable reviews. - -::: - -### **Need help?** - -If you require assistance, our support team is here to help. Simply click on the -help icon within the CodeRabbit user interface. For more detailed information, -please refer to the "Support" section. Additionally, consider joining the -CodeRabbit Discord community to connect with other users and access a wealth of -knowledge about using CodeRabbit effectively. diff --git a/docs/guides/_category_.yml b/docs/guides/_category_.yml new file mode 100644 index 00000000..5db22a7a --- /dev/null +++ b/docs/guides/_category_.yml @@ -0,0 +1,4 @@ +label: Guides +position: 3 +collapsible: true +collapsed: true diff --git a/docs/guides/customize-coderabbit.md b/docs/guides/configure-coderabbit.md similarity index 82% rename from docs/guides/customize-coderabbit.md rename to docs/guides/configure-coderabbit.md index 85abe63f..d7a9a449 100644 --- a/docs/guides/customize-coderabbit.md +++ b/docs/guides/configure-coderabbit.md @@ -1,25 +1,25 @@ --- -title: Customize CodeRabbit -sidebar_label: Customize CodeRabbit +title: Configure CodeRabbit +sidebar_label: Configure CodeRabbit description: - CodeRabbit offers various customization options to tailor the reviews to your - specific requirements. Customizations can be made using one of the below + CodeRabbit offers various configuration options to tailor the reviews to your + specific requirements. Configuration can be made using one of the below options. --- -CodeRabbit offers various customization options to tailor the reviews to your -requirements. Customizations can be made using one of the below options : +CodeRabbit offers various configuration options to tailor the reviews to your +requirements. Configuration can be made using one of the below options : -1. **Customization via CodeRabbit YAML File** _(Recommended)_ -2. **Customization via CodeRabbit UI** +1. **Configure using CodeRabbit YAML File** _(Recommended)_ +2. **Configure using CodeRabbit UI** -Customization defined in the YAML file overrides the settings in the UI. +Configuration defined in the YAML file overrides the settings in the UI. -### 1. Customize CodeRabbit using a YAML File[](https://coderabbit.ai/docs/get-started/customize-coderabbit) +### 1. Configure CodeRabbit using a YAML File {#yaml} -You can add a `.coderabbit.yaml` configuration file to your repositories. Below -is a sample YAML file that can be used as a starting point and changed as -needed: +You can add a `.coderabbit.yaml` configuration file to the root of your +repositories. Below is a sample YAML file that can be used as a starting point +and changed as needed: #### version 2: `Current` @@ -55,24 +55,17 @@ reviews: - "feat/.*" tools: ast-grep: - rule_dirs: + rule_dirs: - "rules" - util_dirs: + util_dirs: - "utils" packages: - "ast-grep-essentials" - - "my-awesome-org/my-awesome-package" # public repository that contains ast-grep + - "my-awesome-org/my-awesome-package" # public GitHub repository that contains ast-grep rules chat: auto_reply: true ``` -:::note - -`.coderabbit.yaml` file should be placed in the root directory of the -repository. - -::: - YAML settings: 1. **`language`**: Set the language for reviews using the ISO language code. For @@ -110,11 +103,12 @@ YAML settings: apart from the default branch. Accepts regex pattern. - **`tools`**: Configurations for the tools used in the review. - **`ast-grep`**: Configurations for the `ast-grep` tool. - - **`rule_dirs`**: The directory name where the custom `ast-grep` - rules are stored. - - **`util_dirs`**: The directory name where the custom `ast-grep` - utils are stored. - - **`packages`**: A package allows you to share rules across multiple projects. Essentially, a package is a collection of `ast-grep` rules. + - **`rule_dirs`**: The directory name where the custom `ast-grep` rules + are stored. + - **`util_dirs`**: The directory name where the custom `ast-grep` utils + are stored. + - **`packages`**: A package allows you to share rules across multiple + projects. Essentially, a package is a collection of `ast-grep` rules. 4. **`chat`**: Defines the behavior of CodeRabbit's bot in conversations. - **`auto_reply`**: The bot automatically replies without the need of the user tagging it (default: `true`). @@ -126,7 +120,7 @@ Refer: version 1 (deprecated) -#### version 1: `deprecated` (Please use version [version 2](/guides/customize-coderabbit)) +#### Version 1: `deprecated` (Please use version [version 2](#yaml)) ```yaml settings: @@ -161,7 +155,6 @@ settings: # Disable automatic code reviews for this repository. disable_review: false # External tools configurations - ``` This configuration file consists of the following settings: @@ -194,27 +187,24 @@ This configuration file consists of the following settings: 13. **`collapse_walkthrough_comment`**: Specifies whether to collapse walkthrough comments on the review. - Refer: [CodeRabbit configuration schema](https://coderabbit.ai/integrations/coderabbit-overrides.json). -### 2. Customize CodeRabbit through the UI [](https://coderabbit.ai/docs/get-started#2-customize-coderabbit-through-the-ui-dashboard) +### 2. Configure CodeRabbit through the UI -Reviews can also be customized through the UI under repository settings: +Reviews can also be configured through the UI under repository settings: --- -### Review Customization[](https://coderabbit.ai/docs/get-started#review-customization) - -[](../get-started/images/tailor2.png) +### Review Configuration **Path-based instructions :** Provide additional review guidelines based on the file paths using glob patterns. For further guidance, please refer to this -section [Prompt Customization](/guides/prompt-customization) +section [Review Instructions](./review-instructions.md). **Language Selection:** Select the natural language in which you want the review feedback. CodeRabbit supports most of the widely used languages. The default @@ -225,9 +215,7 @@ added with the pull request description. --- -### Review Filters [](https://coderabbit.ai/docs/get-started#review-filters) - -[](../get-started/images/tailor3.png) +### Review Filters **Disable Reviews:** Disables automatic code reviews for the repository. Reviews can be initiated on-demand using CodeRabbit commands. diff --git a/docs/guides/prompt-customization.md b/docs/guides/review-instructions.md similarity index 93% rename from docs/guides/prompt-customization.md rename to docs/guides/review-instructions.md index 392dec30..9608522b 100644 --- a/docs/guides/prompt-customization.md +++ b/docs/guides/review-instructions.md @@ -1,13 +1,13 @@ --- -title: Prompt Customization -sidebar_label: Prompt Customization +title: Review Instructions +sidebar_label: Review Instructions description: CodeRabbit offers various customization options to tailor the reviews to your specific requirements. Customizations can be made using one of the below options. --- -### Path-based instructions {#path-based-instructions} +### Path-based instructions {#path-based} This section explains how to add custom code review instructions for the entire project or specific file paths in your project using glob patterns. Developers @@ -19,7 +19,7 @@ Adding file path prompts allows developers to specify custom instructions for different parts of the codebase. For example, you may want to enforce a style guide by file types or directories. -### Sample Usage {#sample-usage} +### Sample Usage - **`path`**: `**/*.js` @@ -43,7 +43,7 @@ guide by file types or directories. ::: -## Abstract Syntax Tree (AST) instructions +## Abstract Syntax Tree (AST) based instructions {#ast-based} :::note @@ -74,7 +74,8 @@ By default, you can add `ast-grep` rules by following these steps: 5. Add the rules' directory to the `.coderabbit.yml` file under `tools.ast-grep` configuration. 6. Optionally, you can add `packages` property to the configuration to specify - the packages that should be installed before running the `ast-grep` tool. Please read the `packages` section for detailed information. + the packages that should be installed before running the `ast-grep` tool. + Please read the `packages` section for detailed information. ```yaml #... @@ -82,9 +83,9 @@ reviews: #... tools: ast-grep: - rule_dirs: + rule_dirs: - "custom-name" - packages: + packages: - "ast-grep-essentials" # default package installed #... ``` @@ -253,8 +254,8 @@ my-awesome-project # project root > `.coderabbit.yml` file under `tools.ast-grep` configuration. > The rules can also be inside a package. If you have a package that contains - rules, you can add the package name to the `packages` field in the - `.coderabbit.yml` file. +> rules, you can add the package name to the `packages` field in the +> `.coderabbit.yml` file. ```yaml #... @@ -262,9 +263,9 @@ reviews: #... tools: ast-grep: - rule_dirs: + rule_dirs: - "rules" - util_dirs: + util_dirs: - "utils" packages: - "ast-grep-essentials" @@ -291,15 +292,20 @@ rule: > [Utility Rule](https://ast-grep.github.io/guide/rule-config/utility-rule.html) ### Packages -A package is what allows you to share rules across multiple projects. Essentially, a package is a collection of ast-grep rules. -Coderabbit provides a set of packages that you can use out of the box. You can also create your own packages and share them with the community or just -use them within your organization. +A package is what allows you to share rules across multiple projects. +Essentially, a package is a collection of ast-grep rules. + +Coderabbit provides a set of packages that you can use out of the box. You can +also create your own packages and share them with the community or just use them +within your organization. Packages provided by Coderabbit are: + - `ast-grep-essentials`: A set of essential security rules -To use a package, you need to add the package name to the `packages` field in the `.coderabbit.yml` file. +To use a package, you need to add the package name to the `packages` field in +the `.coderabbit.yml` file. ```yaml #... @@ -313,9 +319,12 @@ reviews: ``` #### Using custom package -Let's say that you have a public repository that contains ast-grep rules. You can add the package name to the `packages` field in the `.coderabbit.yml` file. + +Let's say that you have a public repository that contains ast-grep rules. You +can add the package name to the `packages` field in the `.coderabbit.yml` file. Requirements for a package: + - should be a public repository - contains rules that follow the ast-grep rule format - package name should be in the format `organization/repository` diff --git a/docs/integrations/_category_.yml b/docs/integrations/_category_.yml new file mode 100644 index 00000000..17af8110 --- /dev/null +++ b/docs/integrations/_category_.yml @@ -0,0 +1,4 @@ +label: Integrations +position: 4 +collapsible: true +collapsed: true diff --git a/docs/integrations/self-hosted-gitlab.md b/docs/integrations/self-hosted-gitlab.md index 90b0f5b8..e3c74007 100644 --- a/docs/integrations/self-hosted-gitlab.md +++ b/docs/integrations/self-hosted-gitlab.md @@ -13,14 +13,14 @@ complete, you can log in directly using the OAuth2 flow. ### **Step 1: Getting Started** -**Visit CodeRabbit:** Land on to our [Login](https://coderabbit.ai/login) page -and select Self-Hosted GitLab +**Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and +select Self-Hosted GitLab ![login-page](./images/login-page.png) -### Step 2: Enter your Self Managed GitLab URL +### Step 2: Enter your Self-Managed GitLab URL -On this page, enter the URL of your self managed GitLab instance and click +On this page, enter the URL of your self-managed GitLab instance and click submit. Once, you submit, we check our database for a record of your organization. @@ -64,7 +64,5 @@ the token, please follow the process outlined below: Use this CodeRabbit IP if your instance requires IP whitelisting `35.222.179.152/32` -VPN tunneling is available as an add-on package. Please reach out to us at contact@coderabbit.ai if you are interested. - -- Furthermore, please refer to our Get Started Guide to make the most of - CodeRabbit [here](../get-started/add-repo.md). +VPN tunneling is available as an add-on package. Please reach out to us at +[contact@coderabbit.ai](mailto:contact@coderabbit.ai) if you are interested. diff --git a/docs/introduction/introduction.md b/docs/introduction/introduction.md index 42723100..b39eb18c 100644 --- a/docs/introduction/introduction.md +++ b/docs/introduction/introduction.md @@ -2,6 +2,7 @@ id: introduction title: What is CodeRabbit? sidebar_label: Introduction +sidebar_position: 1 description: CodeRabbit is an innovative, AI-first code reviewer. It provides context-aware review feedback on a pull request within minutes, thereby significantly @@ -12,10 +13,10 @@ slug: "/" **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 +Additionally, 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. +generate code. It learns from your suggestions and gets better over time. **CodeRabbit** seamlessly integrates with GitHub and GitLab repositories, performing continuous, incremental reviews for each commit within a pull @@ -30,17 +31,22 @@ 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. -![](../about/images/CodeRabbitFlow.png) +![CodeRabbit Flow](../about/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 and there is zero data retention on LLMs. -Neither we nor the LLM we use share any data collected during the code review -process with other third parties. +influence the models. Queries to the Large Language Models (LLMs) are ephemeral +and there is zero retention on LLMs. Neither we nor the LLMs provider(s) share +any data collected during the code review process with third parties. -Does CodeRabbit store my Data? -CodeRabbit enhances future reviews for your organization by storing the embeddings of the learnings generated from chat conversations. Additionally, it integrates embeddings from issues in workflow systems (Liner, Jira, GitHub/GitLab issues) to assess the impact of code changes on existing issues +Data storage: Code downloaded during the review process is stored temporarily +and is deleted after the review processing is complete. The code is not stored +or used for any other purpose. However, CodeRabbit enhances future reviews for +your organization by storing the embeddings of the learnings generated from chat +conversations. Additionally, it integrates embeddings from issues in workflow +systems (Liner, Jira, GitHub/GitLab issues) to assess the impact of code changes +on existing issues Compliance and Data Privacy: Your data is kept confidential, isolated by the organization, and used only to improve your organization reviews. Data storage @@ -61,7 +67,8 @@ auto-generate meaningful code for moderately complex applications. ### How is CodeRabbit different from existing code review tools? -Traditional code review tools excel in linting and static analysis, but they fall short in providing context-aware, conversational feedback with actionable suggestions for changes that can be directly committed. - -For information on how to get started with **CodeRabbit**, please visit the -[Get Started page](./get-started/signup). +Traditional code review tools excel in linting and static analysis, but they +fall short in providing context-aware, conversational feedback with actionable +suggestions for changes that can be directly committed. On the other hand, +**CodeRabbit** leverages AI to understand the intent behind the code changes and +provide human-like feedback for applying the best practices. diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 6de38c27..7e6c7ea3 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -40,8 +40,16 @@ const config: Config = { { redirects: [ { - to: "https://docs.coderabbit.ai/docs/get-started/signup", - from: "/docs/get-started", + from: "/get-started", + to: "/guides/configure-coderabbit", + }, + { + from: "/guides/customize-coderabbit", + to: "/guides/configure-coderabbit", + }, + { + from: "/guides/prompt-customization", + to: "/guides/review-instructions", }, ], }, diff --git a/sidebars.ts b/sidebars.ts index d69dcf2b..c19fe0da 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -12,38 +12,10 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; */ const sidebars: SidebarsConfig = { docsSidebar: [ - "introduction/introduction", { - type: "category", - label: "About", - collapsed: false, - items: ["about/features", "about/pricing", "about/support"], + type: "autogenerated", + dirName: ".", }, - { - type: "category", - label: "Get Started", - items: [ - "get-started/signup", - "get-started/add-repo", - "get-started/analytics", - ], - }, - { - type: "category", - label: "Guides", - items: [ - "guides/customize-coderabbit", - "guides/prompt-customization", - "guides/coderabbit-commands", - "guides/daily-standup-report" - ], - }, - { - type: "category", - label: "Integrations", - items: ["integrations/self-hosted-gitlab"], - }, - "faq/faq", ], }; pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy