WalkthroughDocumentation updates were made to the VSCode extension guides. Two existing guides had new links added to a self-hosting setup guide. One guide was revised to clarify configuration for self-hosted use. A new guide was introduced, detailing how to connect the VSCode extension to a self-hosted CodeRabbit instance. Changes| File(s) | Change Summary |
|---|
docs/guides/about-vscode.md,
docs/guides/install-vscode.md | Added a "What's next" link to the new self-hosted setup guide. | | docs/guides/config-vscode.md | Replaced the "Set a review timeout" section with a new section clarifying self-hosted usage and configuration. | | docs/guides/use-vscode-selfhosted.md | Added a new guide with step-by-step instructions for using the VSCode extension with a self-hosted CodeRabbit. |
Estimated code review effort1 (~5 minutes) Poem🐇
A hop through docs, a guide anew,
For self-hosted bunnies and their clever crew.
With links and steps, the path is clear,
VSCode and CodeRabbit—bring them near!
So nibble these docs, don’t delay—
Your self-hosted journey starts today!
Pre-Merge Checks (1 passed, 2 warnings)❌ Failed Checks (2 warnings)| Check Name | Status | Explanation | Resolution |
|---|
| Title Check | ⚠️ Warning | The title "add docs for extension with self-hosted" is vague and does not clearly specify which extension or the context of self-hosted CodeRabbit, nor follow conventional formatting. | Revise the pull request title to be clear and specific, for example: "docs: add guide for using VSCode extension with self-hosted CodeRabbit". | | Description Check | ⚠️ Warning | The pull request description is empty and lacks context, a summary of changes, and rationale for the documentation updates. | Provide a detailed description summarizing the changes (new self-hosted usage guide and updates to existing docs), explain the motivation for these additions, and consider adding a pull request template to the repository to ensure all necessary information is captured. |
✅ Passed Checks (1 passed)| Check Name | Status | Explanation |
|---|
| Docstring Coverage | ✅ Passed | No functions found in the changes. Docstring coverage check skipped. |
Impact AnalysisAdded "Use with Self-hosted CodeRabbit" link to install-vscode guideℹ️ Low 📋 Updated docs/guides/install-vscode.md to include a new bullet under the "What's next" section linking to the self-hosted VSCode usage guide (/guides/use-vscode-selfhosted), improving discoverability of self-hosted setup instructions. Verify that the link text and URL are correct and that the target guide exists and renders properly in the documentation site. Preview the markdown or generated site to ensure the link appears under the "What's next" section and navigates to the intended guide without errors. 🔍 Related Filesdocs/guides/install-vscode.md
📜 Recent review detailsConfiguration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro 📥 CommitsReviewing files that changed from the base of the PR and between53b0b43 and0486dec. 📒 Files selected for processing (1)docs/guides/install-vscode.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)- docs/guides/install-vscode.md
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere 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.
SupportNeed 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.
|
No description provided.