Skip to content

Commit 12c7d8a

Browse files
authored
Add the review-instructions guide back to the ToC. (#322)
* Add the Review instructions page back to the ToC. It was accidentally dropped in #301. * Style tweaks
1 parent 8831f9b commit 12c7d8a

File tree

5 files changed

+6
-7
lines changed

5 files changed

+6
-7
lines changed

docs/faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Email field and click Update to save your changes.
9292
### Usage and Configuration
9393

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

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

113113
:::tip Collaboration Mode
114114
When team members are active in PRs, use `@coderabbitai` to engage the bot.

docs/guides/linked-issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,6 @@ Only the issue title and description are considered in the assessment. Comments
168168

169169
## Related Resources
170170

171-
- [Review Instructions](./review-instructions.md)
171+
- [Add review instructions](/guides/review-instructions)
172172
- [Issue Chat](./issue-chat.md)
173173
- [Issue Creation](./issue-creation.md)

docs/guides/review-instructions.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
---
2-
title: Review Instructions
3-
sidebar_label: Review Instructions
2+
title: Add review instructions
43
description:
54
CodeRabbit offers various customization options to tailor the reviews to your
65
specific requirements. Customizations can be made using one of the below
76
options.
8-
sidebar_position: 2
97
---
108

119
The guide explains how to add custom review instructions for the entire project.

docs/platforms/github-com.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ CodeRabbit generates detailed statistics and test plans for each pull request.
109109

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

112-
> 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/)
112+
> 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)
113113
114114
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.
115115

sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ const sidebars: SidebarsConfig = {
7575
items: [
7676
"getting-started/configure-coderabbit",
7777
"integrations/knowledge-base",
78+
"guides/review-instructions",
7879
"tools/tools",
7980
],
8081
},

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy