Skip to content

Commit 504f3a8

Browse files
committed
update knowledge_base settings
1 parent 8042ab2 commit 504f3a8

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

docs/guides/configure-coderabbit.md

+30-10
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ YAML settings:
5252
'You must use talk like Mr. T. I pity the fool who doesn't!'
5353
3. **`early_access`**: Enroll in the early access program to take advantage of
5454
forthcoming features before their general release (default:`false`).
55-
4. **`reviews`**: Configurations for the code reviews.
55+
4. **`reviews`**: Configures review settings.
5656

5757
- **`request_changes_workflow`**: Enable request changes review workflow for
5858
CodeRabbit reviews. (default: `false`).
@@ -90,7 +90,7 @@ YAML settings:
9090
purpose of each test."
9191
```
9292

93-
- **`auto_review`**: Manages settings for automated code reviews, such as:
93+
- **`auto_review`**: Manages settings for automated code reviews.
9494

9595
- **`enabled`**: Automated code review (default: `true`).
9696
- **`ignore_title_keywords`**: Review will be ignored if a pull request
@@ -109,9 +109,9 @@ YAML settings:
109109
- "feat/.*"
110110
```
111111

112-
- **`tools`**: Configurations for the tools used in the review.
112+
- **`tools`**: Configures external tools integration settings.
113113

114-
- **`ast-grep`**: Configurations for the `ast-grep` tool.
114+
- **`ast-grep`**: Configuration for `ast-grep` integration.
115115
- **`rule_dirs`**: The directory name where the custom `ast-grep` rules
116116
are stored.
117117
- **`util_dirs`**: The directory name where the custom `ast-grep` utils
@@ -132,9 +132,9 @@ YAML settings:
132132
- **`languagetool`**: Configuration for `languagetool` integration.
133133

134134
- **`enabled`**: Enable integration, defaults to true.
135-
- **`level`**: The level of the rule. Can be one `default` or `picky`. If
136-
set to `picky`, additional rules will be activated, i.e. rules that you
137-
might only find useful when checking formal text.
135+
- **`level`**: The level of the rule. It can be one `default` or `picky`.
136+
If set to `picky`, additional rules will be activated, i.e. rules that
137+
you might only find useful when checking formal text.
138138
- **`enabled_rules`**: IDs of rules to be enabled. The rule won't run
139139
unless 'level' is set to a level that activates the rule.
140140
- **`disabled_rules`**: IDs of rules to be disabled.
@@ -169,7 +169,28 @@ YAML settings:
169169
- "CASING"
170170
```
171171

172-
5. **`chat`**: Defines the behavior of CodeRabbit's bot in conversations.
172+
5. **`knowledge_base`**: Configures knowledge base settings.
173+
174+
- **`learnings`**: Configures learnings settings.
175+
- **`scope`**: Specify the scope of learnings to use for the knowledge
176+
base. `local` uses the repository's learnings, `global` uses the
177+
organization's learnings, and `auto` uses repository's learnings for
178+
public repositories and organization's learnings for private
179+
repositories.
180+
- **`issues`**: Configures issues settings.
181+
- **`scope`**: Specify the scope of git platform (GitHub/GitLab) issues to
182+
use for the knowledge base. `local` uses the repository's issues,
183+
`global` uses the organization's issues, and `auto` uses repository's
184+
issues for public repositories and organization's issues for private
185+
repositories.
186+
- **`jira`**: Configures Jira settings.
187+
- **`project_keys`**: A list of Jira project keys to use for the knowledge
188+
base. If not provided, all projects will be used.
189+
- **`linear`**: Configures Linear settings.
190+
- **`team_keys`**: A list of Linear team keys to use for the knowledge
191+
base. If not provided, all teams will be used.
192+
193+
6. **`chat`**: Defines the behavior of CodeRabbit's bot in conversations.
173194
- **`auto_reply`**: The bot automatically replies without the need of the
174195
user tagging it (default: `true`).
175196

@@ -180,7 +201,7 @@ Refer:
180201

181202
<summary> version 1 (deprecated) </summary>
182203

183-
#### Version 1: `deprecated` (Please use version [version 2](#yaml))
204+
#### Version 1: `deprecated` (Please use [version 2](#yaml))
184205

185206
```yaml
186207
settings:
@@ -214,7 +235,6 @@ settings:
214235
collapse_walkthrough_comment: true
215236
# Disable automatic code reviews for this repository.
216237
disable_review: false
217-
# External tools configurations
218238
```
219239

220240
This configuration file consists of the following settings:

0 commit comments

Comments
 (0)