Add detailed configuration options for CodeRabbit settings #267
Conversation
WalkthroughThe pull request adds a new documentation section in the CodeRabbit guide. This section provides detailed information on 24 configuration options available to customize CodeRabbit’s functionality. The options are organized in a collapsible block and include settings for language, tone, early access features, reviews, auto review, and various other nested configurations. The update enhances the guidance on how to adjust public configuration parameters. Changes
Suggested reviewers
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Deploying coderabbit-docs with
|
| Latest commit: |
3c99239
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7b54b189.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://hasit-config-explain.coderabbit-docs.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/getting-started/configure-coderabbit.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Cloudflare Pages
| ### 8.3. [knowledge_base.learnings](#knowledge_baselearnings) | ||
|
|
||
| - **Type**: `object` | ||
| - **Default**: `{}` | ||
|
|
||
| #### 8.3.1. [knowledge_base.learnings.scope](#knowledge_baselearningsscope) | ||
|
|
||
| - **Description**: Use local, global, or auto scope for knowledge base learnings. | ||
| - `local`: Use repository's learnings. | ||
| - `global`: Use organization’s learnings. | ||
| - `auto`: Public repos → repository’s learnings; private repos → organization’s. | ||
| - **Type**: `string` | ||
| - **Default**: `auto` | ||
| - **Possible Values**: `local`, `global`, `auto` | ||
|
|
||
| ### 8.4. [knowledge_base.issues](#knowledge_baseissues) | ||
|
|
||
| - **Type**: `object` | ||
| - **Default**: `{}` | ||
|
|
||
| #### 8.4.1. [knowledge_base.issues.scope](#knowledge_baseissuesscope) | ||
|
|
||
| - **Description**: Use local, global, or auto scope for git platform issues. | ||
| - **Type**: `string` | ||
| - **Default**: `auto` | ||
| - **Possible Values**: `local`, `global`, `auto` | ||
|
|
||
| ### 8.5. [knowledge_base.jira](#knowledge_basejira) | ||
|
|
||
| - **Type**: `object` | ||
| - **Default**: `{}` | ||
|
|
||
| #### 8.5.1. [knowledge_base.jira.usage](#knowledge_basejirausage) | ||
|
|
||
| - **Description**: Enable Jira as a knowledge base. `'auto'` disables integration for public repos. | ||
| - **Type**: `string` | ||
| - **Default**: `auto` | ||
| - **Possible Values**: `auto`, `enabled`, `disabled` | ||
|
|
||
| #### 8.5.2. [knowledge_base.jira.project_keys](#knowledge_basejiraproject_keys) | ||
|
|
||
| - **Description**: Jira project keys to use for the knowledge base. | ||
| - **Type**: `array of strings` | ||
| - **Default**: `[]` | ||
|
|
||
| ### 8.6. [knowledge_base.linear](#knowledge_baselinear) | ||
|
|
||
| - **Type**: `object` | ||
| - **Default**: `{}` | ||
|
|
||
| #### 8.6.1. [knowledge_base.linear.usage](#knowledge_baselinearusage) | ||
|
|
||
| - **Description**: Enable Linear as a knowledge base. `'auto'` disables integration for public repos. | ||
| - **Type**: `string` | ||
| - **Default**: `auto` | ||
| - **Possible Values**: `auto`, `enabled`, `disabled` | ||
|
|
||
| #### 8.6.2. [knowledge_base.linear.team_keys](#knowledge_baselinearteam_keys) | ||
|
|
||
| - **Description**: Linear team identifiers (e.g., `"ENG"`) to use for the knowledge base. | ||
| - **Type**: `array of strings` | ||
| - **Default**: `[]` | ||
|
|
||
| ### 8.7. [knowledge_base.pull_requests](#knowledge_basepull_requests) | ||
|
|
||
| - **Type**: `object` | ||
| - **Default**: `{}` | ||
|
|
||
| #### 8.7.1. [knowledge_base.pull_requests.scope](#knowledge_basepull_requestsscope) | ||
|
|
||
| - **Description**: Scope of pull requests (local, global, or auto) for the knowledge base. | ||
| - **Type**: `string` | ||
| - **Default**: `auto` | ||
| - **Possible Values**: `local`, `global`, `auto` | ||
|
|
||
| --- | ||
|
|
||
| ## 9. code_generation | ||
|
|
||
| **Description**: Settings related to code generation. | ||
| **Type**: `object` | ||
| **Default**: `{}` | ||
|
|
||
| ### 9.1. [code_generation.docstrings](#code_generationdocstrings) | ||
|
|
||
| - **Type**: `object` | ||
| - **Default**: `{}` | ||
| - **Description**: Configure the generation of docstrings. | ||
|
|
||
| #### 9.1.1. [code_generation.docstrings.language](#code_generationdocstringslanguage) | ||
|
|
||
| - **Description**: Language of generated docstrings (ISO code). | ||
| - **Type**: `string` | ||
| - **Default**: `en-US` | ||
| - **Possible Values**: same as [language](#language) field above (ISO language codes). | ||
|
|
||
| --- | ||
|
|
||
| </details> | ||
| ``` |
There was a problem hiding this comment.
💡 Verification agent
❓ Verification inconclusive
Comprehensive Configuration Section Added
The new <details> block providing 24 detailed configuration options is very thorough and well-organized. The use of collapsible sections helps manage the document’s clarity while exposing advanced configuration details for users. Each option is clearly described with its type, default values, constraints, and, when applicable, possible values. Overall, this addition significantly improves guidance for customizing CodeRabbit.
However, please double-check the anchor IDs for consistency and uniqueness. For example, the anchor for reviews.tools.ast-grep.essential_rules is currently set to #reviewstoolsast-greprule_dirs, which duplicates the anchor of reviews.tools.ast-grep.rule_dirs. Unique anchors are essential for proper in-page navigation and linking.
Action: Correct Duplicate Anchor IDs in the Configuration Document
The new collapsible configuration block is well-organized and provides comprehensive details for customizing CodeRabbit. However, there is an issue with duplicate anchor IDs that can impair in-page navigation. For instance, the anchor for reviews.tools.ast-grep.essential_rules is set to #reviewstoolsast-greprule_dirs, which duplicates the anchor for reviews.tools.ast-grep.rule_dirs. Please update the anchor for essential_rules (for example, to #reviewstoolsast-grepessential_rules) and verify that all anchor IDs in the document are unique and consistent.
No description provided.