Skip to content

Commit 3c690e4

Browse files
committed
Many improvements and clarifications.
1 parent d6f26ff commit 3c690e4

File tree

5 files changed

+384
-358
lines changed

5 files changed

+384
-358
lines changed

docs/guides/configuration-overview.md

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ sidebar_label: Overview
55
---
66

77
After you finish [integrating CodeRabbit with your Git platform](/platforms/),
8-
you can configure CodeRabbit to best fit the needs of your organization, team,
9-
and individual code repositories.
8+
you can configure CodeRabbit to best fit the needs of your Git platform's organization and repositories.
109

1110
## About CodeRabbit configuration
1211

@@ -17,40 +16,37 @@ adding code reviews to new pull requests in your repositories.
1716

1817
However, understanding how to configure CodeRabbit lets you tune its behavior
1918
to the particulars of your team's code. A few advantages of manually configuring
20-
CodeRabbit inlcude the following:
19+
CodeRabbit include the following:
2120

22-
- Let CodeRabbit deliver its reviews more quickly by giving it guidance on the level of review detail you want.
23-
- Get more meaningful code reviews by specifying the parts of your repository that CodeRabbit should read to gain context.
24-
- Make sure that CodeRabbit works in compliance with your organiation's data-retention policies.
21+
- Adjust the level of detail in CodeRabbit code reviews.
22+
- Customize review instructions to meet your specific coding standards.
23+
- Take advantage of agentic workflows that can speed up your review cycles.
2524

2625
## Configuration methods {#methods}
2726

2827
You can configure CodeRabbit in several ways, from global organization settings
29-
down to configuration directives for specific repositories:
28+
down to configuration directives for specific repositories.
3029

31-
- Configure the default behavior of CodeRabbit
32-
across your whole organization, using the CodeRabbit web UI.
33-
- Configure the behavior of CodeRabbit when reviewing pull requests in a specific repository. You can do this in two ways:
34-
- Use the CodeRabbitweb UI.
35-
- Add a `coderabbit.yaml` file to the top level of your repository.
30+
### Organization settings {#org}
3631

37-
To determine its behavior with a specific repository, CodeRabbit applies the configuration methods in the following order of precedence, from highest to lowest:
32+
If you want to apply the same CodeRabbit configuration to all of your organization's repositories, then
33+
you can manage organizational settings using the CodeRabbit web UI.
3834

39-
1. The [repository's `coderabbit.yaml` file](/getting-started/configure-coderabbit), if it has one.
40-
1. The [repository's settings](/guides/repository-settings) as they appear in the CodeRabbit web UI.
41-
1. The [organization's settings](/guides/organization-settings) as they appear in the CodeRabbit web UI.
35+
For more information, see [Set your organization preferences](/guides/organization-settings).
4236

43-
If you are new to CodeRabbit, then we encourage you to explore the settings available through the CodeRabbit web UI
44-
to become familiar with the options available to you, and their default values.
37+
### Repository settings {#repo}
38+
39+
If you want to apply separate CodeRabbit configuration to your organization's different repositories, then you can
40+
manage repository-specific CodeRabbit settings in two ways:
41+
42+
- Use the CodeRabbit web interface.
43+
- Add a `coderabbit.yaml` file to the top level of your repository.
44+
45+
For more information, see [Set your repository preferences](/guides/repository-settings).
46+
47+
While the web interface provides and easier way to explore the available configuration options for your repository, we recommend using a `coderabbit.yaml` file as a best practice. For more information, see [Fine-tune reviews using YAML files](/guides/setup-best-practices#yaml).
4548

4649
## Initial configuration {#initial}
4750

4851
The [Initial configuration guide](/guides/initial-configuration) tours you through several settings that we
4952
recommend that you review after you set up CodeRabbit with your organization.
50-
51-
## What's next {#whats-next}
52-
53-
- [Set your organization preferences](/guides/organization-settings)
54-
- [Set your repository preferences](/guides/repository-settings)
55-
- [Add a configuration file](/getting-started/configure-coderabbit)
56-
- [Initial configuration guide](/guides/initial-configuration)

0 commit comments

Comments
 (0)