Skip to content

Commit 4b0aa43

Browse files
committed
update docs
1 parent 2acbf36 commit 4b0aa43

File tree

4 files changed

+28
-51
lines changed

4 files changed

+28
-51
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,4 @@
2020
npm-debug.log*
2121
yarn-debug.log*
2222
yarn-error.log*
23+
yarn.lock

docs/guides/coderabbit-commands.md

-48
This file was deleted.

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

+25-1
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@ description:
55
CodeRabbit offers various configuration options to tailor the reviews to your
66
specific requirements. Configuration can be made using one of the below
77
options.
8-
sidebar_position: 2
8+
sidebar_position: 1
99
---
1010

11+
```mdx-code-block
1112
import SchemaViewer from "@site/src/components/SchemaViewer";
13+
```
1214

1315
CodeRabbit offers various configuration options to tailor the reviews to your
1416
requirements. Configuration can be made using one of the below options, in order
@@ -26,7 +28,29 @@ You can add a `.coderabbit.yaml` configuration file to the root of your
2628
repositories. Below is a sample YAML file that can be used as a starting point
2729
and changed as needed:
2830

31+
```yaml
32+
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
33+
language: "en-US"
34+
early_access: false
35+
reviews:
36+
profile: "chill"
37+
request_changes_workflow: false
38+
high_level_summary: true
39+
poem: true
40+
review_status: true
41+
collapse_walkthrough: false
42+
auto_review:
43+
enabled: true
44+
drafts: false
45+
chat:
46+
auto_reply: true
47+
```
48+
49+
The configuration file can be used to set the following options:
50+
51+
```mdx-code-block
2952
<SchemaViewer />
53+
```
3054

3155
Refer:
3256
[CodeRabbit Configuration Schema](https://coderabbit.ai/integrations/schema.v2.json).

docs/guides/review-instructions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ description:
55
CodeRabbit offers various customization options to tailor the reviews to your
66
specific requirements. Customizations can be made using one of the below
77
options.
8-
sidebar_position: 3
8+
sidebar_position: 2
99
---
1010

1111
The guide explains how to add custom review instructions for the entire project.
12-
Also, see the guide on how to [configure CodeRabbit](./configure-coderabbit.mdx).
12+
Also, see the guide on how to [configure CodeRabbit](./configure-coderabbit.md).
1313

1414
### Path-based instructions {#path-based}
1515

0 commit comments

Comments
 (0)