Skip to content

Commit ca3d6aa

Browse files
committed
doc fixes
1 parent 76aa32c commit ca3d6aa

32 files changed

+82
-224
lines changed

docs/about/_category_.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
label: About
2+
position: 2
3+
collapsible: true
4+
collapsed: true

docs/faq/faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ reviews possible.
6767
#### Can I customize CodeRabbit?
6868

6969
Reviews are customizable. For information, check out our
70-
[Get Started page](../get-started/signup.md).
70+
[Customization](../guides/review-instructions.md) guide.
7171

7272
#### Can I choose a language other than English for the reviews?
7373

docs/get-started/add-repo.md

-39
This file was deleted.

docs/get-started/analytics.md

-35
This file was deleted.

docs/get-started/images/add2.png

-51.4 KB
Binary file not shown.

docs/get-started/images/add3.png

-53.7 KB
Binary file not shown.
Binary file not shown.
-271 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.
-282 KB
Binary file not shown.
-267 KB
Binary file not shown.
-271 KB
Binary file not shown.
-61.6 KB
Binary file not shown.
-71.9 KB
Binary file not shown.

docs/get-started/images/cr_login.png

-72.4 KB
Binary file not shown.

docs/get-started/images/cr_login2.png

-187 KB
Binary file not shown.
-191 KB
Binary file not shown.
-125 KB
Binary file not shown.
-79.7 KB
Binary file not shown.

docs/get-started/images/tailor2.png

-69 KB
Binary file not shown.

docs/get-started/images/tailor3.png

-147 KB
Binary file not shown.

docs/get-started/images/ymlrabbit.png

-366 KB
Binary file not shown.

docs/get-started/signup.md

-60
This file was deleted.

docs/guides/_category_.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
label: Guides
2+
position: 3
3+
collapsible: true
4+
collapsed: true

docs/guides/customize-coderabbit.md renamed to docs/guides/configure-coderabbit.md

+28-36
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
---
2-
title: Customize CodeRabbit
3-
sidebar_label: Customize CodeRabbit
2+
title: Configure CodeRabbit
3+
sidebar_label: Configure CodeRabbit
44
description:
5-
CodeRabbit offers various customization options to tailor the reviews to your
6-
specific requirements. Customizations can be made using one of the below
5+
CodeRabbit offers various configuration options to tailor the reviews to your
6+
specific requirements. Configuration can be made using one of the below
77
options.
88
---
99

10-
CodeRabbit offers various customization options to tailor the reviews to your
11-
requirements. Customizations can be made using one of the below options :
10+
CodeRabbit offers various configuration options to tailor the reviews to your
11+
requirements. Configuration can be made using one of the below options :
1212

13-
1. **Customization via CodeRabbit YAML File** _(Recommended)_
14-
2. **Customization via CodeRabbit UI**
13+
1. **Configure using CodeRabbit YAML File** _(Recommended)_
14+
2. **Configure using CodeRabbit UI**
1515

16-
Customization defined in the YAML file overrides the settings in the UI.
16+
Configuration defined in the YAML file overrides the settings in the UI.
1717

18-
### 1. Customize CodeRabbit using a YAML File[](https://coderabbit.ai/docs/get-started/customize-coderabbit)
18+
### 1. Configure CodeRabbit using a YAML File {#yaml}
1919

20-
You can add a `.coderabbit.yaml` configuration file to your repositories. Below
21-
is a sample YAML file that can be used as a starting point and changed as
22-
needed:
20+
You can add a `.coderabbit.yaml` configuration file to root of your
21+
repositories. Below is a sample YAML file that can be used as a starting point
22+
and changed as needed:
2323

2424
#### version 2: `Current`
2525

@@ -55,24 +55,17 @@ reviews:
5555
- "feat/.*"
5656
tools:
5757
ast-grep:
58-
rule_dirs:
58+
rule_dirs:
5959
- "rules"
60-
util_dirs:
60+
util_dirs:
6161
- "utils"
6262
packages:
6363
- "ast-grep-essentials"
64-
- "my-awesome-org/my-awesome-package" # public repository that contains ast-grep
64+
- "my-awesome-org/my-awesome-package" # public GitHub repository that contains ast-grep rules
6565
chat:
6666
auto_reply: true
6767
```
6868
69-
:::note
70-
71-
`.coderabbit.yaml` file should be placed in the root directory of the
72-
repository.
73-
74-
:::
75-
7669
YAML settings:
7770
7871
1. **`language`**: Set the language for reviews using the ISO language code. For
@@ -110,11 +103,12 @@ YAML settings:
110103
apart from the default branch. Accepts regex pattern.
111104
- **`tools`**: Configurations for the tools used in the review.
112105
- **`ast-grep`**: Configurations for the `ast-grep` tool.
113-
- **`rule_dirs`**: The directory name where the custom `ast-grep`
114-
rules are stored.
115-
- **`util_dirs`**: The directory name where the custom `ast-grep`
116-
utils are stored.
117-
- **`packages`**: A package allows you to share rules across multiple projects. Essentially, a package is a collection of `ast-grep` rules.
106+
- **`rule_dirs`**: The directory name where the custom `ast-grep` rules
107+
are stored.
108+
- **`util_dirs`**: The directory name where the custom `ast-grep` utils
109+
are stored.
110+
- **`packages`**: A package allows you to share rules across multiple
111+
projects. Essentially, a package is a collection of `ast-grep` rules.
118112
4. **`chat`**: Defines the behavior of CodeRabbit's bot in conversations.
119113
- **`auto_reply`**: The bot automatically replies without the need of the
120114
user tagging it (default: `true`).
@@ -126,7 +120,7 @@ Refer:
126120

127121
<summary> version 1 (deprecated) </summary>
128122

129-
#### version 1: `deprecated` (Please use version [version 2](/guides/customize-coderabbit))
123+
#### version 1: `deprecated` (Please use version [version 2](#yaml))
130124

131125
```yaml
132126
settings:
@@ -161,7 +155,6 @@ settings:
161155
# Disable automatic code reviews for this repository.
162156
disable_review: false
163157
# External tools configurations
164-
165158
```
166159

167160
This configuration file consists of the following settings:
@@ -194,27 +187,26 @@ This configuration file consists of the following settings:
194187
13. **`collapse_walkthrough_comment`**: Specifies whether to collapse
195188
walkthrough comments on the review.
196189

197-
198190
Refer:
199191
[CodeRabbit configuration schema](https://coderabbit.ai/integrations/coderabbit-overrides.json).
200192

201193
</details>
202194

203-
### 2. Customize CodeRabbit through the UI [](https://coderabbit.ai/docs/get-started#2-customize-coderabbit-through-the-ui-dashboard)
195+
### 2. Configure CodeRabbit through the UI
204196

205-
Reviews can also be customized through the UI under repository settings:
197+
Reviews can also be configured through the UI under repository settings:
206198

207199
---
208200

209-
### Review Customization[](https://coderabbit.ai/docs/get-started#review-customization)
201+
### Review Configuration
210202

211203
[](../get-started/images/tailor2.png)
212204

213205
**Path-based instructions :** Provide additional review guidelines based on the
214206
file paths using glob patterns.
215207

216208
For further guidance, please refer to this
217-
section [Prompt Customization](/guides/prompt-customization)
209+
section [Prompt Configuration](/guides/prompt-configuration)
218210

219211
**Language Selection:** Select the natural language in which you want the review
220212
feedback. CodeRabbit supports most of the widely used languages. The default
@@ -225,7 +217,7 @@ added with the pull request description.
225217

226218
---
227219

228-
### Review Filters [](https://coderabbit.ai/docs/get-started#review-filters)
220+
### Review Filters
229221

230222
[](../get-started/images/tailor3.png)
231223

0 commit comments

Comments
 (0)