Skip to content

Commit 3fe0701

Browse files
committed
Tweaks
1 parent acda0e6 commit 3fe0701

File tree

2 files changed

+20
-22
lines changed

2 files changed

+20
-22
lines changed

docs/guides/initial-configuration.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,7 @@ for a while, when you feel ready to customize its behavior.
2020

2121
Each section in the guide links to specific entries in the configuration reference. Each entry in the linked reference specifies the location of its configuration setting, in either the CodeRabbit web UI or your `.coderabbit.yaml` file.
2222

23-
## General settings {#general}
24-
25-
These settings adjust overall CodeRabbit code review behavior.
26-
27-
### Adjust code-review strictness {#profile}
28-
29-
If you want CodeRabbit to apply a much stricter and more nitpicky stance to its code reviews, then you can switch its _profile_ setting from `chill` to `assertive`.
30-
31-
CodeRabbit is aware of nitpickier output from the linters and other tools that it applies to code reviews, but includes less of it in its own review comments when the profile is set to `chill`. To have CodeRabbit include more nitpicky tool output in reviews, use the `assertive` profile.
32-
33-
For more information, see [Profile](/reference/configuration#profile) in the configuration reference.
34-
35-
### Configure learnings {#learnings}
36-
37-
By default, CodeRabbit learns your team's review preferences by letting you [teach it your preferences in plain language during code reviews](/integrations/knowledge-base#learnings). CodeRabbit remembers these preferences, and applies them to subsequent code reviews in the same repository.
38-
39-
If you don't want this feature, you can disable it. For more information, see [Learnings](/reference/configuration#learnings) in the configuration reference.
40-
41-
## Data retention settings {#data-retention}
23+
## Data retention and knowledge base settings {#data-retention}
4224

4325
These settings help you control how much data about your code that CodeRabbit retains.
4426
CodeRabbit temporarily stores information about your repositories in order to tailored reviews more quickly and better tailored to your team's needs. You can opt of these features if your organization has stricter data-retention policies.
@@ -68,11 +50,17 @@ For more information, see
6850

6951
### Configure knowledge base retention {#opt-out}
7052

71-
By default, CodeRabbit keeps its own [_knowledge base_](/integrations/knowledge-base): a store of metadata about your repositories, your team's history of pull requests, linked issues, and [learnings] about how CodeRabbit should tailor its own review behavior to best serve your team. If this long-term knowledge base storage conflicts with your organization's data-retention policies, then you can disable this feature.
53+
By default, CodeRabbit keeps its own [_knowledge base_](/integrations/knowledge-base): a store of metadata about your repositories, your team's history of pull requests, linked issues, and learnings about how CodeRabbit should tailor its own review behavior to best serve your team. If this long-term knowledge base storage conflicts with your organization's data-retention policies, then you can disable this feature.
7254

7355
For more information, see
7456
[Opt out](/reference/configuration#opt-out) in the configuration reference.
7557

58+
### Configure learnings {#learnings}
59+
60+
CodeRabbit learns your team's review preferences by letting you [teach it your preferences in plain language during code reviews](/integrations/knowledge-base#learnings). CodeRabbit remembers these preferences, and applies them to subsequent code reviews in the same repository.
61+
62+
This setting lets you set the scope of which stored learnings that CodeRabbit should apply to its code reviews. For more information, see [Learnings](/reference/configuration#learnings) in the configuration reference.
63+
7664
## Tune the length of code reviews {#content}
7765

7866
By default, CodeRabbit writes thorough code reviews with several sub-sections. If you'd rather have CodeRabbit generated shorter reviews then you can change some of the following settings:
@@ -176,6 +164,14 @@ For more information, see [Tools](/reference/configuration#tools) in the configu
176164

177165
## Other code review settings {#other}
178166

167+
### Adjust code-review strictness {#profile}
168+
169+
If you want CodeRabbit to apply a much stricter and more nitpicky stance to its code reviews, then you can switch its _profile_ setting from `chill` to `assertive`.
170+
171+
CodeRabbit is aware of nitpickier output from the linters and other tools that it applies to code reviews, but includes less of it in its own review comments when the profile is set to `chill`. To have CodeRabbit include more nitpicky tool output in reviews, use the `assertive` profile.
172+
173+
For more information, see [Profile](/reference/configuration#profile) in the configuration reference.
174+
179175
### Configure pull request approval {#request-changes}
180176

181177
By default, CodeRabbit doesn't mark pull requests as approved after any code review, even if CodeRabbit doesn't have any further significant changes to suggest. This leaves the job of formal pull request approval entirely up to human reviewers.

docs/guides/repository-settings.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,10 @@ While the web interface provides an easier way to explore the available configur
2222

2323
## Configure your repository with `.coderabbit.yaml`
2424

25-
For more information about creating and updating a `.coderabbit.yaml` file in
26-
your repository, see [Add a configuration file](/getting-started/configure-coderabbit).
25+
To add a `.coderabbit.yaml` file to your repository, merge a copy of [our template configuration file](/reference/yaml-template)
26+
to the top level of your default branch. From there, you can update your repository's CodeRabbit configuration by updating the `.coderabbit.yaml` file exactly as you would any other text file in your repository.
27+
28+
For more information about the `.coderabbit.yaml` file, see [Add a configuration file](/getting-started/configure-coderabbit).
2729

2830
## Browse and modify your settings using the web interface {#modify}
2931

0 commit comments

Comments
 (0)