doc fixes

coderabbitai · Mar 26, 2024 · ca3d6aa · ca3d6aa
1 parent 76aa32c
commit ca3d6aa
Show file tree

Hide file tree

Showing 32 changed files with 82 additions and 224 deletions.
diff --git a/docs/about/_category_.yml b/docs/about/_category_.yml
@@ -0,0 +1,4 @@
+label: About
+position: 2
+collapsible: true
+collapsed: true
diff --git a/docs/faq/faq.md b/docs/faq/faq.md
@@ -67,7 +67,7 @@ reviews possible.
 #### 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.
 
 #### Can I choose a language other than English for the reviews?
 

diff --git a/docs/get-started/add-repo.md b/docs/get-started/add-repo.md
diff --git a/docs/get-started/analytics.md b/docs/get-started/analytics.md
diff --git a/docs/get-started/images/add2.png b/docs/get-started/images/add2.png
diff --git a/docs/get-started/images/add3.png b/docs/get-started/images/add3.png
diff --git a/docs/get-started/images/committable-suggestion.png b/docs/get-started/images/committable-suggestion.png
diff --git a/docs/get-started/images/cr_add_repo_dark.png b/docs/get-started/images/cr_add_repo_dark.png
diff --git a/docs/get-started/images/cr_add_repo_gitlab_dark.png b/docs/get-started/images/cr_add_repo_gitlab_dark.png
diff --git a/docs/get-started/images/cr_add_repo_gitlab_light.png b/docs/get-started/images/cr_add_repo_gitlab_light.png
diff --git a/docs/get-started/images/cr_add_repo_light.png b/docs/get-started/images/cr_add_repo_light.png
diff --git a/docs/get-started/images/cr_dash_dark.png b/docs/get-started/images/cr_dash_dark.png
diff --git a/docs/get-started/images/cr_dash_light.png b/docs/get-started/images/cr_dash_light.png
diff --git a/docs/get-started/images/cr_history_dark.png b/docs/get-started/images/cr_history_dark.png
diff --git a/docs/get-started/images/cr_history_light.png b/docs/get-started/images/cr_history_light.png
diff --git a/docs/get-started/images/cr_login.png b/docs/get-started/images/cr_login.png
diff --git a/docs/get-started/images/cr_login2.png b/docs/get-started/images/cr_login2.png
diff --git a/docs/get-started/images/cr_login_dark.png b/docs/get-started/images/cr_login_dark.png
diff --git a/docs/get-started/images/issue-validation.png b/docs/get-started/images/issue-validation.png
diff --git a/docs/get-started/images/related-issues.png b/docs/get-started/images/related-issues.png
diff --git a/docs/get-started/images/tailor2.png b/docs/get-started/images/tailor2.png
diff --git a/docs/get-started/images/tailor3.png b/docs/get-started/images/tailor3.png
diff --git a/docs/get-started/images/ymlrabbit.png b/docs/get-started/images/ymlrabbit.png
diff --git a/docs/get-started/signup.md b/docs/get-started/signup.md
diff --git a/docs/guides/_category_.yml 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 → docs/guides/configure-coderabbit.md b/docs/guides/customize-coderabbit.md → 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 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:
 
 <summary> version 1 (deprecated) </summary>
 
-#### 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,26 @@ 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).
 
 </details>
 
-### 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)
+### Review Configuration
 
 [](../get-started/images/tailor2.png)
 
 **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 [Prompt Configuration](/guides/prompt-configuration)
 
 **Language Selection:** Select the natural language in which you want the review
 feedback. CodeRabbit supports most of the widely used languages. The default
@@ -225,7 +217,7 @@ added with the pull request description.
 
 ---
 
-### Review Filters [](https://coderabbit.ai/docs/get-started#review-filters)
+### Review Filters
 
 [](../get-started/images/tailor3.png)