Add troubleshooting and best-practices guides for VSCode extension #331 & #332 #409
Conversation
…oss the CodeRabbit documentation.
WalkthroughTwo new documentation guides were added: one on best practices for using the VSCode extension and another on troubleshooting common issues. The sidebar configuration was updated to include these guides under the "Review local changes" category. No code or logic changes were made. Changes
Assessment against linked issues
Assessment against linked issues: Out-of-scope changes
Poem
✨ Finishing Touches
🧪 Generate Unit Tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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 (
|
![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 (7)
docs/guides/best-practices-vscode.md (4)
6-6: Link to troubleshooting guide
Consider adding a pointer to the troubleshooting guide for users who hit issues before diving into best practices.
Example addition:For troubleshooting common problems, see [Troubleshoot the VSCode extension](/guides/troubleshooting-vscode).
8-23: Expand setup recommendations
It could be helpful to mention customizing core extension settings (e.g., comment sensitivity thresholds, diff context lines) to tailor reviews to your workflow.
46-56: Clarify.coderabbitignoreusage
You may rephrase “you don’t want reviewed” as “you don’t want to be reviewed” or “you don’t want included” for readability.
59-69: Team collaboration tips are solid
Consider suggesting that teams pin a specific extension version in their shared settings to avoid unexpected updates.docs/guides/troubleshooting-vscode.md (3)
6-9: Add link to best practices guide
Round-trip your users by linking back to the best-practices guide in the intro:For proactive usage tips, see [Best practices for using the VSCode extension](/guides/best-practices-vscode).
26-39: Consider verifying Git hooks
You might add a step to confirm that the.git/hooksdirectory is intact, as missing hooks can prevent commit-triggered events.
88-96: Enhance additional help with log locations
Suggest specifying where users can find extension logs (e.g., in the VSCode Output panel under “CodeRabbit” or at~/.vscode/extensions/coderabbitai.coderabbit-vscode/logs).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/guides/best-practices-vscode.md(1 hunks)docs/guides/troubleshooting-vscode.md(1 hunks)sidebars.ts(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/guides/troubleshooting-vscode.md
[uncategorized] ~26-~26: The preposition ‘to’ seems more likely in this position.
Context: .... --- ### 2. Reviews aren't triggered on commit #### Symptoms - Committing cha...
(AI_HYDRA_LEO_REPLACE_ON_TO)
docs/guides/best-practices-vscode.md
[uncategorized] ~49-~49: Possible missing preposition found.
Context: ...Avoid large, monolithic commits Break up big changes into logical units. This...
(AI_HYDRA_LEO_MISSING_TO)
[style] ~49-~49: The word ‘big’ tends to be overused. Consider an alternative.
Context: ...arge, monolithic commits** Break up big changes into logical units. This speeds up revi...
(BIG_DIFFERENCE)
[uncategorized] ~55-~55: Possible missing preposition found.
Context: ...nce. - Use .coderabbitignore Exclude files or directories you don’t want rev...
(AI_HYDRA_LEO_MISSING_TO)
🔇 Additional comments (9)
docs/guides/best-practices-vscode.md (3)
1-4: Frontmatter looks correct
The YAML frontmatter is valid and follows the existing docs convention.
26-43: Daily workflow tips are comprehensive
Great guidance on leveraging incremental commits and manual reviews; no changes needed here.
72-76: Keep your tools updated section is clear
This reminder aligns with best practices.sidebars.ts (1)
129-134: New sidebar entries are correctly placed
The guides for best practices and troubleshooting appear in the intended location under “Review local changes” with proper indentation and ordering.docs/guides/troubleshooting-vscode.md (5)
1-4: Frontmatter is valid
The metadata block is well-formed and consistent with other docs.
10-23: Issue 1 coverage is good
Activation failure scenarios and fixes are clearly laid out.
42-55: Issue 3 is clear and actionable
Branch comparison error guidance is spot on.
58-71: Issue 4 guidance is thorough
Good checklist for missing or misaligned diffs.
73-85: Issue 5 remedies are complete
Crash and unresponsiveness steps cover key diagnostics.
fixes: #331 #332
requester: @jmacdotorg
Summary
This PR introduces two new documentation pages focused on enhancing user experience with the CodeRabbit VSCode extension:
Details
troubleshoot-vscode.mdwith a structured list of common issues, symptoms, and step-by-step fixes.best-practices-vscode.mdoutlining optimal usage patterns, suggested settings, and collaboration strategies.##headers and listsMotivation
To improve usability and support coverage by documenting known pitfalls and offering actionable tips. These pages help developers quickly self-diagnose problems and adopt workflows that maximize CodeRabbit’s value.
Reviewer Notes