docs fix for self-hosted extension #466
Conversation
WalkthroughThe documentation for using the VSCode extension with a self-hosted CodeRabbit instance was reorganized for clarity, with improved prerequisites and step-by-step instructions. Additionally, the sidebar configuration was updated to include this revised guide in the appropriate documentation section. Changes
Estimated code review effort1 (~4 minutes) Possibly related PRs
Poem
Pre-Merge Checks (1 passed, 2 warnings)❌ Failed Checks (2 warnings)
✅ Passed Checks (1 passed)
Impact AnalysisClarify prerequisites and connection steps in self-hosted VSCode extension guideℹ️ Low 📋 The self-hosted VSCode extension guide (docs/guides/use-vscode-selfhosted.md) has been rewritten for clarity: the title was simplified, prerequisites were split into two steps (including an explicit logout requirement), and connection steps were renumbered and reformatted with clearer bulleting and explicit GitHub Enterprise mention. Core instructions remain unchanged. Ensure that the revised steps accurately reflect the current extension UI and behavior, and verify that any screenshots or links align with the new ordering and formatting. Preview the updated guide in the documentation site, walk through the end-to-end self-hosted setup, and confirm that each numbered and bulleted step displays correctly and reads unambiguously. 🔍 Related Files
Add self-hosted VSCode extension guide to documentation sidebarℹ️ Low 📋 The sidebar configuration (sidebars.ts) now includes the new “guides/use-vscode-selfhosted” page in the “Review local changes” section, positioned between the existing VSCode guide and the config-VSCode guide. Verify the sidebar ordering and grouping in both desktop and mobile layouts, and check for any localization or path issues. Build and navigate the documentation site to confirm the new guide appears in the correct location in the sidebar and links resolve properly. 🔍 Related Files
✨ Finishing Touches
🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
ankitjena
force-pushed
the
fix-self-hosted-extension-docs
branch
from
d8e296b to
d88fea8
Compare
Deploying coderabbit-docs with
|
| Latest commit: |
04c45ff
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6ea9b13e.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://fix-self-hosted-extension-do.coderabbit-docs.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
sidebars.ts (1)
130-136: Slug naming consistencyAll other “self-hosted” documentation pages use the dashed form (
self-hosted) in their slugs (self-hosted/github,self-hosted/gitlab, …).
For consistency, consider renaming the new entry toguides/use-vscode-self-hosted(and the underlying file) so that the entire docs tree follows one kebab-case convention.- "guides/use-vscode-selfhosted", + "guides/use-vscode-self-hosted",docs/guides/use-vscode-selfhosted.md (4)
1-4: Minor wording/grammar fixes in front-matter
- The description should use the verb phrase “set up” rather than the noun “setup”.
- Keeping the full phrase “VS Code extension” in the title helps searchability and consistency with other pages.
-title: Use with self-hosted CodeRabbit -description: How to setup the VSCode extension with self-hosted CodeRabbit +title: Use the VS Code extension with self-hosted CodeRabbit +description: How to set up the VS Code extension with self-hosted CodeRabbit
10-11: Clarify prerequisite wording
- “Greater than
0.12.1” excludes0.12.1itself. Usually we mean “>= 0.12.1”.- “Logout” → “Log out” (verb form).
-1. Your extension version should be greater than `0.12.1`. -2. Logout of the extension if previously logged in. +1. Ensure the extension version is **`0.12.1` or newer**. +2. **Log out** of the extension if you were previously signed in.
17-21: Fix typos and provider names
- Add the missing hyphen in “Self-hosting”.
- Capitalisation / spelling:
- “GitLab” (capital L).
- “Self-hosted GitLab” (hyphen, capital L).
- “GitHub” (capital H, capital B).
- Slight wording tweak for bullet 3.
-1. Click on the "Self hosting CodeRabbit?" button, below the "Use CodeRabbit for free" button. +1. Click the **“Self-hosting CodeRabbit?”** button below **“Use CodeRabbit for free”**. @@ -3. Select your git provider which you are using with your self-hosted CodeRabbit. (GitLab, Self-Hosted Gitlab, GitHub, GitHub Enterprise) - - If using GitHub or GitHub Enterprise, enter your [Github Personal Access Token](...) when prompted. +3. Select the Git provider used with your self-hosted CodeRabbit instance: **GitLab**, **Self-hosted GitLab**, **GitHub**, or **GitHub Enterprise**. + - If you choose GitHub or GitHub Enterprise, enter your [GitHub Personal Access Token](...) when prompted.
23-23: Tone & active voiceConsider an active-voice confirmation to match the rest of the guide.
-You should be connected to your self-hosted instance and ready to use the VSCode extension. +You’re now connected to your self-hosted instance and ready to use the VS Code extension.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/guides/use-vscode-selfhosted.md(1 hunks)sidebars.ts(1 hunks)
🧠 Learnings (2)
📓 Common learnings
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#176
File: docs/self-hosted/bitbucket.md:37-37
Timestamp: 2024-12-13T15:10:43.483Z
Learning: In the `docs` repository, it's acceptable to use `127.0.0.1` in documentation examples, and CodeRabbit should not flag it as an issue.
docs/guides/use-vscode-selfhosted.md (1)
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#176
File: docs/self-hosted/bitbucket.md:37-37
Timestamp: 2024-12-13T15:10:43.483Z
Learning: In the `docs` repository, it's acceptable to use `127.0.0.1` in documentation examples, and CodeRabbit should not flag it as an issue.
docs/guides/use-vscode-selfhosted.md (1)
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cloudflare Pages
No description provided.