Add the review-instructions guide back to the ToC.

[jmacdotorg]

Repair a regression introduced with #301.

Normalize a few links and page titles regarding the review-instructions page.

Staged: https://toc-fix.coderabbit-docs.pages.dev/

[coderabbitai]

Walkthrough

The changes update documentation to standardize the naming and linking of the "review instructions" guide. This includes adjusting link texts, updating link URLs to be consistent and relative, modifying document metadata, and adding the guide to the documentation sidebar configuration. No functional or logic changes are introduced.

Changes

File(s)	Change Summary
docs/faq.md	Updated two link texts from "Review Instructions" to "review instructions"; URLs unchanged.
docs/guides/linked-issues.md	Changed link text to "Add review instructions" and updated URL to absolute path.
docs/guides/review-instructions.md	Changed document title to "Add review instructions" and removed sidebar metadata.
docs/platforms/github-com.md	Changed documentation link from absolute to relative URL for review instructions.
sidebars.ts	Added "guides/review-instructions" to the "Configure CodeRabbit" category in the sidebar.

Poem

In the docs, we hopped around,
Tweaking links where they are found.
"Review instructions" now aligned,
With tidy paths and titles refined.
Sidebar burrows, neat and new—
A rabbit’s work, both swift and true!
🐇📚

✨ Finishing Touches

• 📝 Generate Docstrings
• 📝 Generate Unit Tests in Pull Request

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[cloudflare-workers-and-pages]

Deploying coderabbit-docs with    Cloudflare Pages

Latest commit:	309b17d
Status:	✅  Deploy successful!
Preview URL:	https://762c8763.coderabbit-docs.pages.dev
Branch Preview URL:	https://toc-fix.coderabbit-docs.pages.dev

View logs

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

docs/platforms/github-com.md (1)

112-112: Unify link wording and improve sentence flow
The link text [adding custom review instructions](/guides/review-instructions) is descriptive but diverges from the standardized title "Add review instructions" used elsewhere. Consider updating it to match the page title (e.g., [Add review instructions]) or capitalizing "Adding" for consistency. Additionally, this sentence follows several with similar structure—rephrasing could enhance readability.

🧰 Tools

🪛 LanguageTool

[style] ~112-~112: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...it](/img/integrations/test-plan.png) > CodeRabbit also allows you to configure **custom r...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

docs/faq.md (2)

95-95: Align FAQ link text with guide title
The link [review instructions](/guides/review-instructions) is lowercased and omits "Add". To maintain uniformity across the docs, consider using [Add review instructions](/guides/review-instructions).

---

111-111: Align FAQ interaction link text with guide title
Similarly, the link in the interaction guide section uses [review instructions](/guides/review-instructions). For consistency with the actual page title, change to [Add review instructions](/guides/review-instructions).

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8831f9b and 309b17d.

📒 Files selected for processing (5)

• docs/faq.md (2 hunks)
• docs/guides/linked-issues.md (1 hunks)
• docs/guides/review-instructions.md (1 hunks)
• docs/platforms/github-com.md (1 hunks)
• sidebars.ts (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/platforms/github-com.md

[style] ~112-~112: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...it](/img/integrations/test-plan.png) > CodeRabbit also allows you to configure **custom r...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Cloudflare Pages

🔇 Additional comments (3)

sidebars.ts (1)

78-78: Sidebar integration of review instructions guide
The entry "guides/review-instructions" is correctly inserted under the "Configure CodeRabbit" category between "integrations/knowledge-base" and "tools/tools", restoring the guide to the Table of Contents as intended.

docs/guides/linked-issues.md (1)

171-171: Consistent link text matching the guide title
The link text [Add review instructions](/guides/review-instructions) now exactly matches the frontmatter title of the target page, ensuring clarity and consistency.

docs/guides/review-instructions.md (1)

2-2: Frontmatter title update is correct
The title has been updated to Add review instructions, and removal of sidebar_label/sidebar_position is appropriate given the explicit sidebar configuration in sidebars.ts. This aligns with the PR objectives.

[karan925]

lgtm