Commit12c7d8a

authored

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

* Add the Review instructions page back to the ToC.It was accidentally dropped incoderabbitai#301.* Style tweaks

1 parent8831f9b commit12c7d8aCopy full SHA for 12c7d8a

File tree

-7

lines changed

-7

lines changed

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ Email field and click Update to save your changes.`
`92`	`92`	`###Usage and Configuration`
`93`	`93`
`94`	`94`	`-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)`
`96`	`96`	`-Branch Selection: Default branch reviews enabled by default (configurable)`
`97`	`97`
`98`	`98`	`###Access & Permissions`
`@@ -108,7 +108,7 @@ Interact with CodeRabbit by:`
`108`	`108`	`1. Replying directly to CodeRabbit comments`
`109`	`109`	2. Tagging`@coderabbitai` in PR discussions
`110`	`110`	`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)`
`112`	`112`
`113`	`113`	`:::tip Collaboration Mode`
`114`	`114`	When team members are active in PRs, use`@coderabbitai` to engage the bot.

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -168,6 +168,6 @@ Only the issue title and description are considered in the assessment. Comments`
`168`	`168`
`169`	`169`	`##Related Resources`
`170`	`170`
`171`		`--[Review Instructions](./review-instructions.md)`
	`171`	`+-[Add review instructions](/guides/review-instructions)`
`172`	`172`	`-[Issue Chat](./issue-chat.md)`
`173`	`173`	`-[Issue Creation](./issue-creation.md)`

Lines changed: 1 addition & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,9 @@`
`1`	`1`	`---`
`2`		`-title:Review Instructions`
`3`		`-sidebar_label:Review Instructions`
	`2`	`+title:Add review instructions`
`4`	`3`	`description:`
`5`	`4`	`CodeRabbit offers various customization options to tailor the reviews to your`
`6`	`5`	`specific requirements. Customizations can be made using one of the below`
`7`	`6`	`options.`
`8`		`-sidebar_position:2`
`9`	`7`	`---`
`10`	`8`
`11`	`9`	`The guide explains how to add custom review instructions for the entire project.`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ CodeRabbit generates detailed statistics and test plans for each pull request.`
`109`	`109`
`110`	`110`	`![Test Plan by CodeRabbit](/img/integrations/test-plan.png)`
`111`	`111`
`112`		`->CodeRabbit also allows you to configurecustom 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 configurecustom 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)`
`113`	`113`
`114`	`114`	`Whether you manage a popular repository or are working on a smaller project, whether it's hosted onGitLab, 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.`
`115`	`115`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -75,6 +75,7 @@ const sidebars: SidebarsConfig = {`
`75`	`75`	`items:[`
`76`	`76`	`"getting-started/configure-coderabbit",`
`77`	`77`	`"integrations/knowledge-base",`
	`78`	`+"guides/review-instructions",`
`78`	`79`	`"tools/tools",`
`79`	`80`	`],`
`80`	`81`	`},`

Comments

(0)