Skip to content

Update documentation to use consistent "path instructions" terminology #472

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+5 −5
Open

Update documentation to use consistent "path instructions" terminology #472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eee8116
path based to path instructions
aravindputrevu Jul 23, 2025
3aae6b7
Merge branch 'main' into path-based-to-path-fix
aravindputrevu Jul 25, 2025
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
2 changes: 1 addition & 1 deletion docs/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ Pair these IDE-embedded reviews with our deeper Git-platform reviews for a multi

### Docstring Path Instructions

You can now provide path-based instructions for the generation of docstring in `.coderabbit.yaml`.
You can now provide file path instructions for the generation of docstring in `.coderabbit.yaml`.

Example:

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/initial-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ You can give CodeRabbit additional instructions for reviewing specific files or
locations in your repository, or configure CodeRabbit to disregard certain file paths
during code reviews.

For an overview about using path-based instructions in CodeRabbit, see [Path-based instructions](/guides/review-instructions#path-based).
For an overview about using path instructions in CodeRabbit, see [Path instructions](/guides/review-instructions#path-based).

### Add path filters {#filters}

Expand Down Expand Up @@ -115,7 +115,7 @@ For more information, see [Path instructions](/reference/configuration#path-inst
### Add documentation or unit-test path instructions {#doc-path}

Similar to the general path instructions described by the previous section, you
can define path-based instructions that direct CodeRabbit to generate inline
can define path instructions that direct CodeRabbit to generate inline
documentation or unit tests, with specific instructions associated with different
locations or filenames.

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/review-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description:
The guide explains how to add custom review instructions for the entire project.
Also, see the guide on how to [configure CodeRabbit](/getting-started/configure-coderabbit).

## Path-based instructions {#path-based}
## Path instructions {#path-based}

This section explains how to add custom code review instructions for the entire
project or specific file paths in your project using glob patterns. Developers
Expand Down
2 changes: 1 addition & 1 deletion docs/overview/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ For example, if CodeRabbit uses a linter to suggest that your pull request use f

For a video introduction to this feature, see [CodeRabbit Learnings](https://www.youtube.com/watch?v=Yu0cmmOYA-U).

If you need to fine-tune CodeRabbit's behavior beyond this, then you can [add a CodeRabbit-specific configuration file](/getting-started/configure-coderabbit) to your repository, or use the CodeRabbit web UI to set further preferences. This file can include [path-based instructions](/guides/review-instructions) for how CodeRabbit should review different files within your codebase.
If you need to fine-tune CodeRabbit's behavior beyond this, then you can [add a CodeRabbit-specific configuration file](/getting-started/configure-coderabbit) to your repository, or use the CodeRabbit web UI to set further preferences. This file can include [path instructions](/guides/review-instructions) for how CodeRabbit should review different files within your codebase.

No matter how you tune and customize CodeRabbit, its default settings make it useful out of the box, able to meaningfully review pull requests within minutes of its introduction to a repository.

Expand Down