Skip to content

Add the review-instructions guide back to the ToC. #322

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 2 commits into from
May 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Email field and click Update to save your changes.
### Usage and Configuration

- **Language Settings**: Configure review language in repository settings
- **Review Rules**: Customize via [Review Instructions](/guides/review-instructions)
- **Review Rules**: Customize via [review instructions](/guides/review-instructions)
- **Branch Selection**: Default branch reviews enabled by default (configurable)

### Access & Permissions
Expand All @@ -108,7 +108,7 @@ Interact with CodeRabbit by:
1. Replying directly to CodeRabbit comments
2. Tagging `@coderabbitai` in PR discussions
3. Adding review comments for specific lines
4. Customize via [Review Instructions](/guides/review-instructions)
4. Customize via [review instructions](/guides/review-instructions)

:::tip Collaboration Mode
When team members are active in PRs, use `@coderabbitai` to engage the bot.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/linked-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,6 @@ Only the issue title and description are considered in the assessment. Comments

## Related Resources

- [Review Instructions](./review-instructions.md)
- [Add review instructions](/guides/review-instructions)
- [Issue Chat](./issue-chat.md)
- [Issue Creation](./issue-creation.md)
4 changes: 1 addition & 3 deletions docs/guides/review-instructions.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
---
title: Review Instructions
sidebar_label: Review Instructions
title: Add review instructions
description:
CodeRabbit offers various customization options to tailor the reviews to your
specific requirements. Customizations can be made using one of the below
options.
sidebar_position: 2
---

The guide explains how to add custom review instructions for the entire project.
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/github-com.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ CodeRabbit generates detailed statistics and test plans for each pull request.

![Test Plan by CodeRabbit](/img/integrations/test-plan.png)

> CodeRabbit also allows you to configure **custom review instructions** based on your organization's needs, in case you want it to follow specific guidelines beyond the standard review, to learn more on [adding custom review instructions](https://docs.coderabbit.ai/guides/review-instructions/)
> CodeRabbit also allows you to configure **custom review instructions** based on your organization's needs, in case you want it to follow specific guidelines beyond the standard review, to learn more on [adding custom review instructions](/guides/review-instructions)

Whether you manage a popular repository or are working on a smaller project, whether it's hosted on **GitLab, GitHub, or self-hosted GitHub or GitLab**, CodeRabbit can help streamline your development process. This AI Code Review assistant is designed to save you time by automating code reviews and offering insightful feedback.

Expand Down
1 change: 1 addition & 0 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ const sidebars: SidebarsConfig = {
items: [
"getting-started/configure-coderabbit",
"integrations/knowledge-base",
"guides/review-instructions",
"tools/tools",
],
},
Expand Down