> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Settings map

> Find a setting by its YAML key or its web interface label, and jump to the page that explains it.

The settings map connects common settings across the places you meet them: the YAML V2 key, the label you see in the web interface, the YAML V3 key, the feature page that explains the setting, and the entry in the configuration reference. Search for a key or a label, then follow the links.

The map covers the settings people look up most. For every key, see the [V2 reference](https://docs.coderabbit.ai/reference/configuration.md) and the [V3 reference](https://docs.coderabbit.ai/reference/configuration-v3.md). For every V2 key and its V3 location, see [Map V2 keys to V3](https://docs.coderabbit.ai/configuration/guides/migrate-to-v3.md#map-v2-keys-to-v3).

## How to read the map

| Column | What it shows |
| - | - |
| YAML V2 key | The dotted path in `.coderabbit.yaml` with the default schema |
| Web interface label | The setting name and its section path under **Review > Review settings** |
| YAML V3 key | The dotted path in a schema V3 file, or a note when V3 has no YAML key |
| Feature page | The page that explains what the setting does and when to change it |
| Reference | The entry for the key in the configuration reference, for V2 and V3 |

Schema V3 is a limited preview. A V2 key that moved in V3 shows its new path. A V2 key that V3 fixes to a value, or keeps outside the file, says so in the V3 column.

## Settings in the web interface

Each row links to the reference entry for the key in both schemas.

| YAML V2 key | Web interface label | YAML V3 key | Feature page | Reference |
| - | - | - | - | - |
| `language` | **Language**, in **General** | `language` | [Review style](https://docs.coderabbit.ai/pr-reviews/review-style.md) | [V2](https://docs.coderabbit.ai/reference/configuration.md#param-language), [V3](https://docs.coderabbit.ai/reference/configuration-v3.md#param-language) |
| `tone_instructions` | **Tone instructions**, in **General** | `fun.tone_instructions` | [Review style](https://docs.coderabbit.ai/pr-reviews/review-style.md) | [V2](https://docs.coderabbit.ai/reference/configuration.md#param-tone-instructions), [V3](https://docs.coderabbit.ai/reference/configuration-v3.md#param-fun-tone-instructions) |
| `reviews.profile` | **Profile**, in **Reviews > General** | `reviews.behavior.profile` | [Review style](https://docs.coderabbit.ai/pr-reviews/review-style.md) | [V2](https://docs.coderabbit.ai/reference/configuration.md#param-reviews-profile), [V3](https://docs.coderabbit.ai/reference/configuration-v3.md#param-reviews-behavior-profile) |
| `reviews.auto_review.enabled` | **Automatic review**, in **Reviews > Auto review** | `reviews.auto_review.enabled` | [When reviews run](https://docs.coderabbit.ai/pr-reviews/when-reviews-run.md) | [V2](https://docs.coderabbit.ai/reference/configuration.md#param-reviews-auto-review-enabled), [V3](https://docs.coderabbit.ai/reference/configuration-v3.md#param-reviews-auto-review-enabled) |
| `reviews.path_filters` | **Path filters**, in **Reviews > General** | `reviews.behavior.path_filters` | [Which files are reviewed](https://docs.coderabbit.ai/pr-reviews/which-files.md) | [V2](https://docs.coderabbit.ai/reference/configuration.md#param-reviews-path-filters), [V3](https://docs.coderabbit.ai/reference/configuration-v3.md#param-reviews-behavior-path-filters) |
| `reviews.high_level_summary` | **High level summary**, in **Reviews > General** | `reviews.output.summary.placement` (`off`, `description`, `walkthrough`) | [PR Summaries](https://docs.coderabbit.ai/pr-reviews/summaries.md) | [V2](https://docs.coderabbit.ai/reference/configuration.md#param-reviews-high-level-summary), [V3](https://docs.coderabbit.ai/reference/configuration-v3.md#param-reviews-output-summary-placement) |
| `reviews.review_status` | **Review status**, in **Reviews > General** | `reviews.output.walkthrough.review_status` | [PR Walkthroughs](https://docs.coderabbit.ai/pr-reviews/walkthroughs.md) | [V2](https://docs.coderabbit.ai/reference/configuration.md#param-reviews-review-status), [V3](https://docs.coderabbit.ai/reference/configuration-v3.md#param-reviews-output-walkthrough-review-status) |
| `reviews.auto_approvals.enabled` (legacy alias: `reviews.request_changes_workflow`) | **Automatic approvals**, in **Reviews > General** | `reviews.behavior.auto_approvals.enabled` | [Automatic Approvals](https://docs.coderabbit.ai/pr-reviews/automatic-approvals.md) | [V2](https://docs.coderabbit.ai/reference/configuration.md#param-reviews-auto-approvals-enabled), [V3](https://docs.coderabbit.ai/reference/configuration-v3.md#param-reviews-behavior-auto-approvals-enabled) |

Section paths follow the settings index: flat fields at the top of the file appear in **General**, flat fields under `reviews` appear in **Reviews > General**, and most objects under `reviews`, such as `auto_review`, have their own page. `reviews.auto_approvals` is an exception: it's a section of **Reviews > General**.

## Compare a setting in V2 and V3

Most V2 keys move to a new path in V3: review behavior goes under `reviews.behavior`, comment output under `reviews.output`, and personality settings under `fun`. A few V2 keys have no V3 key. V3 fixes `reviews.poem` and `reviews.sequence_diagrams` off and `chat.auto_reply` on, and keeps settings such as `knowledge_base` outside the file. [Map V2 keys to V3](https://docs.coderabbit.ai/configuration/guides/migrate-to-v3.md#map-v2-keys-to-v3) lists every key.

> [tab] YAML V2
>
> ```yaml theme={null}
> reviews:
>   profile: assertive
> ```

> [tab] YAML V3
>
> Early Access (This feature is in early access. Enable it by setting `early_access: true` in your `.coderabbit.yaml`, or by toggling Early Access on the web interface.)
>
> V3 is a limited preview. Adding `version: 3` doesn't give your organization access.
>
> ```yaml theme={null}
> version: 3
> reviews:
>   behavior:
>     profile: assertive
> ```

## Settings that live outside YAML

With V3, these V2 settings have no key in the file. For a repository in the preview, set them under the same keys in the **Preferences YAML** editor on the repository's **V3 preferences** page, in the settings index:

* `early_access`
* `knowledge_base`
* `chat.integrations`
* `reviews.finishing_touches` and `reviews.post_merge_actions`
* `code_generation`
* `issue_enrichment`
* `reviews.auto_review.ignore_title_keywords` and `reviews.auto_review.ignore_usernames`

Review instructions and custom checks move out of YAML into Markdown files: `reviews.path_instructions` becomes `.coderabbit/instructions/`, and `reviews.pre_merge_checks.custom_checks` becomes `.coderabbit/pre-merge-checks/`. On GitHub Cloud, these documents also work with V2. See [Instruction and check documents](https://docs.coderabbit.ai/configuration/documents.md).

## What's next

> [card] [Configuration reference](https://docs.coderabbit.ai/reference/configuration.md)
>
> Every V2 key with its type, default and description.

> [card] [Configuration reference V3](https://docs.coderabbit.ai/reference/configuration-v3.md)
>
> Every V3 key. V3 is a limited preview.

> [card] [Tools reference](https://docs.coderabbit.ai/tools/reference.md)
>
> The settings for each review tool.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.