docs: Write a troubleshooting guide for the VSCode extension #332

[syedalinaqihasni]

Fixes: #332
Requester: @jmacdotorg

Summary

This PR adds a new documentation page focused on a troubleshooting guide for the VSCode extension.

Details

• Introduced troubleshooting-vscode.md to provide targeted help for common issues users face with the extension.
• Structured the guide to follow the same format as other docs:
  • Frontmatter with appropriate title and description
  • Clearly defined sections using ## for categories like installation issues, authentication errors, extension not loading, etc.
  • Internal links to relevant docs (e.g., installation guide, GitHub auth setup, logging/debugging).
• Includes actionable steps, terminal commands, and diagnostic tips.
• Aligned language and examples with existing usage patterns and terminology in the CodeRabbit ecosystem.

Motivation

To reduce user friction and support burden by proactively documenting common problems and proven solutions. This guide empowers users to resolve issues independently and ensures smoother onboarding.

Reviewer Notes

• Validate if all high-frequency problems are well covered.
• Suggest additional edge cases or error messages worth including.
• Check if the structure is intuitive enough to serve both new and advanced users.

[coderabbitai]

Walkthrough

A new troubleshooting guide for the CodeRabbit VSCode extension was introduced as a markdown file. The documentation sidebar was updated to include this guide under the "Review local changes" section, positioned before the uninstall guide. No code or API changes were made.

Changes

File(s)	Change Summary
docs/guides/troubleshooting-vscode.md	Added a comprehensive troubleshooting guide for the VSCode extension.
sidebars.ts	Updated sidebar to include the new troubleshooting guide.

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Add a troubleshooting guide for the VSCode extension (#332)	✅
Ensure the guide is accessible via the documentation sidebar (#332)	✅

Poem

A guide for VSCode, now fresh and new,
With steps for each bug you might stumble into.
If reviews misbehave or the extension won’t start,
Just follow the doc—be clever, be smart!
🐇✨ Troubles no more, with wisdom in store!

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6a1f387 and a2f4ae1.

📒 Files selected for processing (1)

• sidebars.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• sidebars.ts

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • 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 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 auto-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 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/guides/troubleshooting-vscode.md (2)

26-38: Prefer “after commit” to avoid ambiguous phrasing

“Reviews aren't triggered on commit” is understandable but slightly awkward. “After commit” (or “upon commit”) is the more common idiom and sidesteps the flagged preposition issue.

-### 2. Reviews aren't triggered on commit
+### 2. Reviews aren't triggered after commit

---

8-88: Add a high-frequency “Authentication / sign-in errors” section

Nearly every new user question in the VSCode repo relates to GitHub token or org-scoping issues, yet the guide omits them. A concise section covering:

• Invalid/expired token symptoms
• Checking CodeRabbit: GitHub Token setting
• Re-authenticating via the command “CodeRabbit: Sign in”
• Org not whitelisted / permission scope mismatch

…would pre-empt a large share of support requests and align with the PR goal of lowering support burden.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7c28895 and 6a1f387.

📒 Files selected for processing (2)

• 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)

🔇 Additional comments (1)

sidebars.ts (1)

131-132: Sidebar entry looks correct

Slug matches the new file path and placement before the uninstall guide is intuitive. ✅