This repository was archived by the owner on Aug 16, 2025. It is now read-only.

coderabbitai/coderabbit-docsPublic archive

NotificationsYou must be signed in to change notification settings
Fork69
Star115

Split the tools page into explainer and reference pages#325

Merged

jmacdotorg merged 3 commits intomainfromsplit-tools

May 19, 2025

Merged

Split the tools page into explainer and reference pages#325

jmacdotorg merged 3 commits intomainfromsplit-tools

May 19, 2025

Conversation

Copy link

Contributor

jmacdotorg commentedMay 9, 2025

Fixes#305.

Split the tools page into seaprate explainer and

a0ce212

references pages.Fixes#305.

jmacdotorg requested a review froma team as acode owner

May 9, 2025 18:39

jmacdotorg requested review fromNickBusey andbar0meter

May 9, 2025 18:39

Copy link

Contributor

coderabbitaibot commentedMay 9, 2025•
edited
Loading

Walkthrough

The changes introduce a new documentation page listing all supported third-party tools, update the existing tools overview page to reference this new list, and modify the sidebar configuration to include the new reference page under the "Supported tools" section.

Changes

File(s)	Change Summary
docs/tools/list.md	Added a new documentation file listing supported third-party tools with categories and links.
docs/tools/tools.md	Revised to remove the tools table, add references to the new list page, and update explanations.
sidebars.ts	Updated sidebar to include the new "tools/list" entry under "Supported tools".

Sequence Diagram(s)

sequenceDiagram    User->>Docs Sidebar: Navigates to "Supported tools"    Docs Sidebar->>list.md: Displays comprehensive tool list    User->>tools.md: Reads explainer about OSS tool usage    tools.md->>list.md: References for full list of tools

Assessment against linked issues

Objective	Addressed	Explanation
Split Tools page into explainer and reference pages (#305)	✅
Move reference overview into reference section of ToC (#305)	✅

Poem

In docs we now have quite a list,
Of tools that no one should have missed.
A sidebar hop, a reference hop—
Now finding linters is a breeze, non-stop!
With markdown tables neat and new,
CodeRabbit brings the tools to you.
🐰✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn morehere.

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configureReview - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off theData Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and betweena0ce212 and48b7f8a.

📒 Files selected for processing (1)

sidebars.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

sidebars.ts

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

GitHub Check: Cloudflare Pages

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate Unit Tests

Create PR with Unit Tests
Commit Unit Tests in branchsplit-tools
Post Copyable Unit Tests in Comment

🪧 Tips

Chat

There are 3 ways to chat withCodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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 oursupport 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 togenerate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for 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 theconfiguration 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 ourDocumentation for detailed information on how to use CodeRabbit.
Join ourDiscord Community to get help, request features, and share feedback.
Follow us onX/Twitter for updates and announcements.

Copy link

cloudflare-workers-and-pagesbot commentedMay 9, 2025•
edited
Loading

Deploying coderabbit-docs with Cloudflare Pages

Latest commit:	`4ad2161`
Status:	✅ Deploy successful!
Preview URL:	https://1cb76d3c.coderabbit-docs.pages.dev
Branch Preview URL:	https://split-tools.coderabbit-docs.pages.dev

View logs

coderabbitaibot reviewed

May 9, 2025

View reviewed changes

Copy link

Contributor

coderabbitaibot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Caution

Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.

Actionable comments posted: 1

🧹 Nitpick comments (4)

docs/tools/list.md (4)
1-4:Frontmatter metadata for new reference page
The YAML frontmatter definestitle anddescription appropriately. Consider adding optional keys such assidebar_position orslug if you need more control over ordering or the URL, though the current sidebar configuration already ensures correct placement.
6-9:Overview and guidance paragraphs
The opening paragraphs clearly explain the purpose of this reference page and how to navigate it. For brevity and consistency, you may consider tightening the language (e.g., replace "This is a list of the third-party open-source linters..." with "List of third-party linters..."), but the current text is informative.
12-48:Comprehensive tools listing table
The markdown table categorizes each tool clearly. For enhanced usability, you might group tools by category (e.g., separate sub-tables for Code Quality vs. Code Security) or add sorting indicators. Otherwise, this structure effectively conveys the information.
49-75:Link reference definitions
All link reference definitions are present and correctly match the table entries. To improve maintainability, consider alphabetizing these definitions or grouping them by category.

🛑 Comments failed to post (1)

docs/tools/list.md (1)
10-11:⚠️ Potential issue
Fix link to configuration overview
The link[Configure third-party tools](/tools/) likely does not resolve to the explainer page located atdocs/tools/tools.md. It should point to its doc IDtools/tools (i.e.,/tools/tools) instead:
- For an overview of how CodeRabbit uses these tools when generating code reviews, as well as general information about controlling their use, see [Configure third-party tools](/tools/).+ For an overview of how CodeRabbit uses these tools when generating code reviews, as well as general information about controlling their use, see [Configure third-party tools](/tools/tools).
📝 Committable suggestion
‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
For an overview of how CodeRabbit uses these tools when generating code reviews, as well as general information about controlling their use, see [Configure third-party tools](/tools/tools).
🤖 Prompt for AI Agents (early access)
In docs/tools/list.md around lines 10 to 11, the link to the configurationoverview uses an incorrect path `/tools/` which does not resolve to the intendedexplainer page. Update the link to use the correct doc ID path `/tools/tools` soit points to docs/tools/tools.md properly.