Skip to content

Add new configuration guides and reference material. #405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Jun 25, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
It's .coderabbit.yaml, not coderabbit.yaml
  • Loading branch information
jmacdotorg committed Jun 23, 2025
commit 64be92a69cd9be9abd45a7ca2cf417189e897574
4 changes: 2 additions & 2 deletions docs/guides/configuration-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ If you want to apply separate CodeRabbit configuration to your organization's di
manage repository-specific CodeRabbit settings in two ways:

- Use the CodeRabbit web interface.
- Add a `coderabbit.yaml` file to the top level of your repository.
- Add a `.coderabbit.yaml` file to the top level of your repository.

For more information, see [Set your repository preferences](/guides/repository-settings).

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).
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).

## Initial configuration {#initial}

Expand Down
8 changes: 4 additions & 4 deletions docs/guides/initial-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ the key settings described by this page can help you tune the behavior of
CodeRabbit for the specific needs of your team. You can use this guide when initially setting up your organization and repositories with CodeRabbit, or you can return to it after using CodeRabbit
for a while, when you feel ready to customize its behavior.

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.
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.

## General settings {#general}

Expand Down Expand Up @@ -120,7 +120,7 @@ For an overview about using path-based instructions in CodeRabbit, see [Path-bas

If your repository contains files or locations that CodeRabbit should disregard when preparing code reviews—or you want CodeRabbit to limit its consideration to only certain files—then you can define one or more _path filters_. Adding path filters to a large repository containing a lot of data, generated files, or other non-code content can let CodeRabbit work faster.

For example, the following `coderabbit.yaml` excerpt instructs CodeRabbit to take review context only the contents of directories named `src/` in your repository, while disregarding any individual files with `.bin` or `.csv` extensions.
For example, the following `.coderabbit.yaml` excerpt instructs CodeRabbit to take review context only the contents of directories named `src/` in your repository, while disregarding any individual files with `.bin` or `.csv` extensions.

```yaml
path_filters:
Expand All @@ -135,7 +135,7 @@ For more information, see [Path filters](/reference/configuration#path-filters)

You can set _path instructions_ that provide CodeRabbit with additional review instructions for various files or locations in your repository. Each path instruction specifies a path specification and a set of instructions, the latter of which you express using natural language.

For example, to give CodeRabbit review instructions specific to JavaScript and TypeScript files, you can add a section like this to your repository's `coderabbit.yaml` file:
For example, to give CodeRabbit review instructions specific to JavaScript and TypeScript files, you can add a section like this to your repository's `.coderabbit.yaml` file:

```yaml
path_instructions:
Expand Down Expand Up @@ -189,7 +189,7 @@ CodeRabbit has access to dozens of industry-standard open-source tools to help i

By default, CodeRabbit considers every tool available to it during code reviews. If you want CodeRabbit to disregard certain tools, then you can disable them.

Several tools that CodeRabbit uses also allow you to specify a path to a tool-specific configuration file in your repository. For example, the following `coderabbit.yaml` excerpt directs CodeRabbit to use configuration files in the repository's `/pmd-config` directory when using the `pmd` tool:
Several tools that CodeRabbit uses also allow you to specify a path to a tool-specific configuration file in your repository. For example, the following `.coderabbit.yaml` excerpt directs CodeRabbit to use configuration files in the repository's `/pmd-config` directory when using the `pmd` tool:

```yaml
reviews:
Expand Down
12 changes: 6 additions & 6 deletions docs/guides/repository-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ Git repository. For a general overview of configuring CodeRabbit, see [Configure
CodeRabbit provides two ways to manage its code-review behavior with each of your organization's repositories:

1. View or modify your per-repository settings using the CodeRabbit web interface.
1. Add a `coderabbit.yaml` file to your repository.
1. Add a `.coderabbit.yaml` file to your repository.

Any settings that you define in the `coderabbit.yaml` file take precedence over
Any settings that you define in the `.coderabbit.yaml` file take precedence over
settings defined by the web interface. If your repository doesn't have a
`coderabbit.yaml` file, then CodeRabbit applies only the settings from the web
`.coderabbit.yaml` file, then CodeRabbit applies only the settings from the web
interface.

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).
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).

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

Expand All @@ -30,9 +30,9 @@ To view of modify your repsository settings using the CodeRabbit web interface,
1. If the **Use Organization Settings** toggle is on, then click it to turn it off. If you leave it on, then CodeRabbit applies the settings you have set through [the organization-configuration page](/guide/organization-settings) to this repository.
1. Browse and modify the settings as needed. If you do make changes, click **Apply Changes** when you are finished.

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

For more information about creating and updating a `coderabbit.yaml` file in
For more information about creating and updating a `.coderabbit.yaml` file in
your repository, see [Add a configuration file](/getting-started/configure-coderabbit).

## What's next {#whats-next}
Expand Down
10 changes: 5 additions & 5 deletions docs/guides/setup-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,18 +66,18 @@ CodeRabbit gives you two ways to configure how it works with your team's reposit

- The **Organization Settings** and **Repositories** pages of [the
CodeRabbit web interface](https://app.coderabbit.ai/login)
- A [`coderabbit.yaml` file](/getting-started/configure-coderabbit/) in your repository
- A [`.coderabbit.yaml` file](/getting-started/configure-coderabbit/) in your repository

The web interface lets you set up your organization's code review
preferences rapidly, and can help you get familiar with CodeRabbit configuration options.

We recommend adding a `coderabbit.yaml` file to repositories, as well. Using this file has several advantages over using only the web interface:
We recommend adding a `.coderabbit.yaml` file to repositories, as well. Using this file has several advantages over using only the web interface:

- It applies version control to your repository's CodeRabbit settings, letting you track changes, view configuration history, and revert to previous configurations as needed.
- During code reviews, CodeRabbit loads the file along with rest of your repository. This means that you can include setting changes as part of a pull request, and CodeRabbit both analyzes and applies these settings during its review.
- The file makes the repository's CodeRabbit settings transparent to all of the repository's contributors.

Repository-level settings defined by a `coderabbit.yaml` take precedence over the
Repository-level settings defined by a `.coderabbit.yaml` take precedence over the
settings defined for that repository or for your organization using the CodeRabbit web interface.

For more information, see [Add a configuration file](/getting-started/configure-coderabbit/).
Expand All @@ -94,7 +94,7 @@ Reducing the number of contextual files that CodeRabbit needs to read and analyz
when preparing a code review can help make its code reviews faster.

You can define path filters using the CodeRabbit
web interface, or with [a `coderabbit.yaml` file](/getting-started/configure-coderabbit/).
web interface, or with [a `.coderabbit.yaml` file](/getting-started/configure-coderabbit/).

### Trust the defaults {#defaults}

Expand All @@ -106,7 +106,7 @@ CodeRabbit gives you control over a number of its core code-review features, let
tools](/tools) that are available to it during code reviews. This helps CodeRabbit keep its reviews broad and flexible.
- **Knowledge base**: CodeRabbit [knowledge base](/integrations/knowledge-base/) features, including learnings and issue tracking, can require data retention. If your organization needs to meet stricter data-retention policies, then you can opt out of using these features.

You can configure your use of the above features using the CodeRabbit web interface, or [a `coderabbit.yaml` file](/getting-started/configure-coderabbit/).
You can configure your use of the above features using the CodeRabbit web interface, or [a `.coderabbit.yaml` file](/getting-started/configure-coderabbit/).

### Write specific CI/CD error messages {#pipeline}

Expand Down
Loading
Loading