Update CodeRabbit documentation

karan925 · karan925 · commit 105b31cc6a27 · 2023-12-22T11:50:05.000-08:00
diff --git a/docs/get-started/add-repo.md b/docs/get-started/add-repo.md
@@ -24,21 +24,18 @@ image: "/preview_meta.jpg"
 
 Learn how to add CodeRabbit to your GitHub or GitLab repositories.
 
-To add additional repositories after the signup, go to the repositories page within the CodeRabbit UI.
+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.
 
 ![Untitled](./images/add1.png)
 
-
-
 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.
 
 ![Untitled](./images/add4.png)
 
-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. 
-
+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.
 
 ### **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.
+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/customize-coderabbit.md b/docs/get-started/customize-coderabbit.md
@@ -23,9 +23,7 @@ show-title: false
   <meta name="twitter:description" content="Accelerate Code Reviews with AI" />
 </head>
 
-### [](https://coderabbit.ai/docs/get-started#3-tailor-coderabbit-to-your-needs)
-
-CodeRabbit offers various customization options to tailor the reviews to your specific requirements. Customizations can be 
+CodeRabbit offers various customization options to tailor the reviews to your specific requirements. Customizations can be
 made using one of the below options :
 
 1. **Customization via CodeRabbit YAML File** _(Recommended)_
@@ -35,102 +33,101 @@ Customization 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-customize-coderabbit-using-a-yaml-file)
 
-You can add a `.coderabbit.yaml` configuration file to your repositories. 
+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 change as needed:
 
-#### Sample :
+#### version 2: `Current`
 
 ```yaml
 language: "jp"
 early_access: false
 reviews:
-  request_changes_workflow: false
-  high_level_summary: true
-  poem: true
-  review_status: true
-  collapse_walkthrough: false
-  path_filters:
-    - "!**/.xml"
-  path_instructions:
-    - path: "**/*.js"
-      instructions: "Review the JavaScript code for conformity with the Google JavaScript style guide, highlighting any deviations."
-    - path: "tests/**/*"
-      instructions: |
-        "Assess the unit test code employing the Mocha testing framework. Confirm that:
-        - The tests adhere to Mocha's established best practices.
-        - Test descriptions are sufficiently detailed to clarify the purpose of each test."
-  auto_review:
-    enabled: true
-    ignore_title_keywords:
-      - "WIP"
-      - "DO NOT MERGE"
-    drafts: false
-    base_branches:
-      - "develop"
-      - "feat/*"
+    request_changes_workflow: false
+    high_level_summary: true
+    poem: true
+    review_status: true
+    collapse_walkthrough: false
+    path_filters:
+        - "!**/.xml"
+    path_instructions:
+        - path: "**/*.js"
+          instructions: "Review the JavaScript code for conformity with the Google JavaScript style guide, highlighting any deviations."
+        - path: "tests/**/*"
+          instructions: |
+              "Assess the unit test code employing the Mocha testing framework. Confirm that:
+              - The tests adhere to Mocha's established best practices.
+              - Test descriptions are sufficiently detailed to clarify the purpose of each test."
+    auto_review:
+        enabled: true
+        ignore_title_keywords:
+            - "WIP"
+            - "DO NOT MERGE"
+        drafts: false
+        base_branches:
+            - "develop"
+            - "feat/*"
 chat:
-  auto_reply: true
+    auto_reply: true
 ```
+
 **Note**: `.coderabbit.yaml` file should be placed at the root directory of the repository.
 
 Yaml settings:
 
 1. **language**: Set the language for reviews using the ISO language code. For example, `"fr"` stands for French (default:`en`).
 
-2. **early_access**: Enroll in the early access program to take advantage of forthcoming features before their general releas (default:`false`).
+2. **early_access**: Enroll in the early access program to take advantage of forthcoming features before their general release (default:`false`).
 
 3. **reviews**: Configurations for the code reviews.
-   - **request_changes_workflow**: Enable Request Changes review workflow for CodeRabbit reviews. (default: `false`).
-   - **high_level_summary**: CodeRabbit generates a high level summary of the changes (default:`true`).
-   - **poem**: Indicates whether a creative poem should be included in the review (default:`true`).
-   - **review_status**: Indicates the status of the review (default:`true`).
-   - **collapse_walkthrough**: Collapses the walkthrough comment (default:`false`).
-   - **path_filters**: Specifies file patterns to exclude or include for a review, such as `!dist/**` and `src/**.tsx`, using glob notation.
-   - **path_instructions**: Provides specific additional guidelines for code review based on file paths. In the given example, JavaScript files are singled out for checks against the Google JavaScript style guide. File path accepts glob pattern
-   - **auto_review**: Manages settings for automated code reviews, such as:
-     - **enabled**: Automated code review (default: `true`).
-     - **ignore_title_keywords**: Review will be ignored if a pull request title contains one of the list of keywords (e.g., `"WIP"`, `"DO NOT MERGE"`).
-     - **labels**: Review will be triggered if a pull request contains one of the list of labels. 
-     - **drafts**: Determines whether draft pull requests are reviewed (default: `true`).
-     - **base_branches**: A list of base branches where the reviews will occur apart from the default branch. Accepts regex pattern.
+    - **request_changes_workflow**: Enable Request Changes review workflow for CodeRabbit reviews. (default: `false`).
+    - **high_level_summary**: CodeRabbit generates a high level summary of the changes (default:`true`).
+    - **poem**: Indicates whether a creative poem should be included in the review (default:`true`).
+    - **review_status**: Indicates the status of the review (default:`true`).
+    - **collapse_walkthrough**: Collapses the walkthrough comment (default:`false`).
+    - **path_filters**: Specifies file patterns to exclude or include for a review, such as `!dist/**` and `src/**.tsx`, using glob notation.
+    - **path_instructions**: Provides specific additional guidelines for code review based on file paths. In the given example, JavaScript files are singled out for checks against the Google JavaScript style guide. File path accepts glob pattern
+    - **auto_review**: Manages settings for automated code reviews, such as:
+        - **enabled**: Automated code review (default: `true`).
+        - **ignore_title_keywords**: Review will be ignored if a pull request title contains one of the list of keywords (e.g., `"WIP"`, `"DO NOT MERGE"`).
+        - **labels**: Review will be triggered if a pull request contains one of the list of labels.
+        - **drafts**: Determines whether draft pull requests are reviewed (default: `true`).
+        - **base_branches**: A list of base branches where the reviews will occur apart from the default branch. Accepts regex pattern.
 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` ).
+    - **auto_reply**: The bot automatically replies without the need of the user tagging it ( default: `true` ).
 
 Refer: [CodeRabbit Configuration Schema](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json).
 
-
-
 #### version 1: `deprecated` (Please use version [version 2](/docs/get-started/customize-coderabbit#example-structure-for-version-2))
 
 ```yaml
 settings:
-  # Enables automatic reviewing of draft pull requests.
-  enable_draft_pr_reviews: true
-  # Specifies additional base/target branches to be reviewed. Accept regex pattern.
-  additional_branches_to_be_reviewed:
-    - "master"
-    - "yaml/test"
-  # Disables generation of release notes.
-  disable_high_level_summary: false
-  # Specific review instructions for certain file paths. File paths accept glob pattern
-  path_based_instructions:
-    - path: "**/*.js"
-      instructions: "Review the javascript code against the google javascript style guide and point out any mismatches"
-    - path: "tests/**/*"
-      instructions:
-        "Review the following unit test code written using the Mocha test library. Ensure that:
-        - The code adheres to best practices associated with Mocha.
-        - Descriptive test names are used to clearly convey the intent of each test."
-  # Comma separated list of keywords in the title that should be ignored.
-  ignored_pr_titles: "WIP"
-  # ISO Code for the review language.
-  review_language: "en"
-  # Disables review and other status comments.
-  disable_review_status: false
-  # Add walkthrough comment in a collapsible section.
-  collapse_walkthrough_comment: true
-  # Disable automatic code reviews for this repository.
-  disable_review: false
+    # Enables automatic reviewing of draft pull requests.
+    enable_draft_pr_reviews: true
+    # Specifies additional base/target branches to be reviewed. Accept regex pattern.
+    additional_branches_to_be_reviewed:
+        - "master"
+        - "yaml/test"
+    # Disables generation of release notes.
+    disable_high_level_summary: false
+    # Specific review instructions for certain file paths. File paths accept glob pattern
+    path_based_instructions:
+        - path: "**/*.js"
+          instructions: "Review the javascript code against the google javascript style guide and point out any mismatches"
+        - path: "tests/**/*"
+          instructions:
+              "Review the following unit test code written using the Mocha test library. Ensure that:
+              - The code adheres to best practices associated with Mocha.
+              - Descriptive test names are used to clearly convey the intent of each test."
+    # Comma separated list of keywords in the title that should be ignored.
+    ignored_pr_titles: "WIP"
+    # ISO Code for the review language.
+    review_language: "en"
+    # Disables review and other status comments.
+    disable_review_status: false
+    # Add walkthrough comment in a collapsible section.
+    collapse_walkthrough_comment: true
+    # Disable automatic code reviews for this repository.
+    disable_review: false
 ```
 
 <!-- ![code](./images/ymlrabbit.png) -->
@@ -153,17 +150,17 @@ This configuration file consists of the following settings:
 
 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. Customize CodeRabbit through the UI [](https://coderabbit.ai/docs/get-started#2-customize-coderabbit-through-the-ui-dashboard)
 
-Reviewes can also be customized through the UI under repository settings:
+Reviews can also be customized through the UI under repository settings:
 
 ### Review Customization[](https://coderabbit.ai/docs/get-started#review-customization)
 
 [](./images/tailor2.png)
 
 **Path based instructions :** Provide additional review guidelines based on the file paths using glob patterns.
 
-For further guidance please refer this section [Prompt Customization](https://coderabbit.ai/docs/get-started/prompt-customization)
+For further guidance please refer this section [Prompt Customization](/docs/get-started/prompt-customization)
 
 **Language Selection:** Select the natural language in which you want the review feedback. CodeRabbit supports most of the widely used languages. The default language is English.
 
@@ -181,4 +178,4 @@ For further guidance please refer this section [Prompt Customization](https://c
 
 **File Pattern:** Include or exclude specific file patterns from the review.
 
- Please note that code reviews commence with new pull requests or incremental commits to existing pull requests once the CodeRabbit app is installed. Should you have any questions or require assistance, our support team is here to help.
+Please note that code reviews commence with new pull requests or incremental commits to existing pull requests once the CodeRabbit app is installed. Should you have any questions or require assistance, our support team is here to help.
diff --git a/docs/get-started/signup.md b/docs/get-started/signup.md
@@ -4,6 +4,7 @@ sidebar_label: Sign Up
 description: Accelerate Code Reviews with AI
 image: "/preview_meta.jpg"
 ---
+
 <head>
  <meta charSet="utf-8" />
   <meta name="title" content="CodeRabbit: AI-powered Code Reviews" />
@@ -49,4 +50,4 @@ Note that the automatic code review behavior can be changed to "On-Demand". To m
 
 ### **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.
+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/introduction/support.md b/docs/introduction/support.md
@@ -4,6 +4,7 @@ sidebar_label: Support
 description: Accelerate Code Reviews with AI
 image: "/preview_meta.jpg"
 ---
+
 <head>
  <meta charSet="utf-8" />
   <meta name="title" content="CodeRabbit: AI-powered Code Reviews" />
@@ -24,17 +25,18 @@ image: "/preview_meta.jpg"
 Welcome to CodeRabbit's Support! Please refer this section if you encounter any issues or have questions. Our support team will respond back as soon as possible.
 
 ### **Common Issues and Answers**
+
 These are the most common questions our support team receives, and you might find an answer here
 
 ### 1. 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/help3.png)
+![Switch Organizations](./images/help3.png)
 
 ### 2. Can CodeRabbit subscription be used across multiple organizations?
 
-Subscription seat are tied to the specific GitHub/GitLab organization under which they are purchased and cannot be used under another organization. 
+Subscription seat are tied to the specific GitHub/GitLab organization under which they are purchased and cannot be used under another organization.
 
 ### 3. Can CodeRabbit review my existing PRs after integrating it?
 
@@ -47,30 +49,29 @@ You need to be GitHub/GitLab admin to add the repositories.
 
 ### 5. Do I need own OpenAI key with CodeRabbit Pro?
 
-OpenAI cost is part of the subscription.There is no additional cost for OpenAI. 
+OpenAI cost is part of the subscription.There is no additional cost for OpenAI.
 
-### 6. What is the differencen between CodeRabbit OSS ai-pr-reviewer and CodeRabbit Pro ?
+### 6. What is the difference between CodeRabbit OSS ai-pr-reviewer and CodeRabbit Pro ?
 
 ai-pr-reviewer 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.
 
-### 7. Can I use both CodeRabbit OSS  and CodeRabbit Pro together ?
+### 7. 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.
 
 ### Explore More
 
 To see more common issues faced by CodeRabbit users, visit our FAQ section for detailed answers and solutions to frequently encountered problems.
 
-
 ### **Opening a Support Ticket**
 
 To get assistance from our support team, open a ticket using the help icon on the CodeRabbit UI:
 
-Complete the support ticket by providing your name, email, a description of your issue, and attaching any necessary files. If you are reporting a bug , please provide the GitHub or GitLab organization name. 
+Complete the support ticket by providing your name, email, a description of your issue, and attaching any necessary files. If you are reporting a bug , please provide the GitHub or GitLab organization name.
 
-   ![Open a Ticket](./images/help2.png)
+![Open a Ticket](./images/help2.png)
 
 ### **Community Collaboration**
 
-Consider joining the CodeRabbit community on Discord. 
+Consider joining the CodeRabbit community on Discord.
