Skip to content

Add a new setup-and-configuration best practices guide. #385

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

Merged
merged 7 commits into from
Jun 6, 2025
Merged

Add a new setup-and-configuration best practices guide. #385

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
47e1947
Add a new setup-and-configuration best practices guide. Move best pra…
jmacdotorg Jun 6, 2025
9582038
Fix broken links
jmacdotorg Jun 6, 2025
804d09e
Merge branch 'main' into best-practices
jmacdotorg Jun 6, 2025
bf7acaf
Add a section about path filters.
jmacdotorg Jun 6, 2025
2f43801
Merge branch 'best-practices' of https://github.com/coderabbitai/code…
jmacdotorg Jun 6, 2025
7240bd0
Typo
jmacdotorg Jun 6, 2025
c221bcc
Merge branch 'main' into best-practices
alexcoderabbitai Jun 6, 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
Prev Previous commit
Next Next commit
Fix broken links
  • Loading branch information
@jmacdotorg
jmacdotorg committed Jun 6, 2025
commit 9582038d172ee40988f8cb42e0edb71700f78cf9
4 changes: 2 additions & 2 deletions docs/guides/setup-best-practices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ advantages over using only the Dashboard:
Repository-level settings defined by a `coderabbit.yaml` take precedence over the same
settings defned for that same repository in the Dashboard.

For more information, see [Add a configuration file](getting-started/configure-coderabbit/).
For more information, see [Add a configuration file](/getting-started/configure-coderabbit/).

### Trust the defaults {#defaults}

Expand All @@ -94,7 +94,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 configuration file](getting-started/configure-coderabbit/).
You can configure your use of the above features using the CodeRabbit web interface, or [a configuration file](/getting-started/configure-coderabbit/).

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

Expand Down