diff --git a/docs/changelog.md b/docs/changelog.md index ec081fb5..edb2ab7d 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -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: diff --git a/docs/guides/initial-configuration.md b/docs/guides/initial-configuration.md index 826a7948..10b8bae2 100644 --- a/docs/guides/initial-configuration.md +++ b/docs/guides/initial-configuration.md @@ -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} @@ -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. diff --git a/docs/guides/review-instructions.md b/docs/guides/review-instructions.md index d74024de..9a298527 100644 --- a/docs/guides/review-instructions.md +++ b/docs/guides/review-instructions.md @@ -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 diff --git a/docs/overview/introduction.md b/docs/overview/introduction.md index f937ac67..ce8349b0 100644 --- a/docs/overview/introduction.md +++ b/docs/overview/introduction.md @@ -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.