Skip to content

Commit 64be92a

Browse files
committed
It's .coderabbit.yaml, not coderabbit.yaml
1 parent 3c690e4 commit 64be92a

File tree

5 files changed

+124
-124
lines changed

5 files changed

+124
-124
lines changed

docs/guides/configuration-overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ If you want to apply separate CodeRabbit configuration to your organization's di
4040
manage repository-specific CodeRabbit settings in two ways:
4141

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

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

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

4949
## Initial configuration {#initial}
5050

docs/guides/initial-configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ the key settings described by this page can help you tune the behavior of
1818
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
1919
for a while, when you feel ready to customize its behavior.
2020

21-
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.
21+
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.
2222

2323
## General settings {#general}
2424

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

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

123-
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.
123+
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.
124124

125125
```yaml
126126
path_filters:
@@ -135,7 +135,7 @@ For more information, see [Path filters](/reference/configuration#path-filters)
135135
136136
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.
137137
138-
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:
138+
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:
139139

140140
```yaml
141141
path_instructions:
@@ -189,7 +189,7 @@ CodeRabbit has access to dozens of industry-standard open-source tools to help i
189189

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

192-
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:
192+
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:
193193

194194
```yaml
195195
reviews:

docs/guides/repository-settings.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ Git repository. For a general overview of configuring CodeRabbit, see [Configure
1111
CodeRabbit provides two ways to manage its code-review behavior with each of your organization's repositories:
1212

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

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

21-
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).
21+
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).
2222

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

@@ -30,9 +30,9 @@ To view of modify your repsository settings using the CodeRabbit web interface,
3030
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.
3131
1. Browse and modify the settings as needed. If you do make changes, click **Apply Changes** when you are finished.
3232

33-
## Configure your repository with `coderabbit.yaml`
33+
## Configure your repository with `.coderabbit.yaml`
3434

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

3838
## What's next {#whats-next}

docs/guides/setup-best-practices.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,18 +66,18 @@ CodeRabbit gives you two ways to configure how it works with your team's reposit
6666

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

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

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

7676
- It applies version control to your repository's CodeRabbit settings, letting you track changes, view configuration history, and revert to previous configurations as needed.
7777
- 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.
7878
- The file makes the repository's CodeRabbit settings transparent to all of the repository's contributors.
7979

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

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

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

9999
### Trust the defaults {#defaults}
100100

@@ -106,7 +106,7 @@ CodeRabbit gives you control over a number of its core code-review features, let
106106
tools](/tools) that are available to it during code reviews. This helps CodeRabbit keep its reviews broad and flexible.
107107
- **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.
108108

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

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

0 commit comments

Comments
 (0)