Clarify plugin installation differences between VSCode and derivatives

[jmacdotorg]

No description provided.

[linear]

ENG-1361 Clarify plugin installation differences between VSCode and derivatives

[traycerai]

Plan

Observations

• No existing VS Code extension documentation in this repository.
• The CodeRabbit VS Code extension is published on VS Marketplace and Open VSX under IDs CodeRabbit.coderabbit-vscode and coderabbit.coderabbit-vscode respectively.
• Docusaurus site uses a custom sidebar in sidebars.ts, and platform integrations are grouped under "Add CodeRabbit to your repository".
• We have CLI commands and gallery configuration for derivatives (VSCodium, VS Code OSS).

Approach

• Create a new Markdown page at docs/platforms/vscode.md using Docusaurus conventions, with YAML frontmatter and two sections: one for stock VS Code (Marketplace) and one for VS Code derivatives (Open VSX, VSCodium, OSS builds).
• In the stock VS Code section, include the code --install-extension CodeRabbit.coderabbit-vscode command and link to the Marketplace URL.
• In the derivatives section, demonstrate codium --install-extension coderabbit.coderabbit-vscode, code-oss usage, gallery settings in settings.json, and manual VSIX sideloading steps.
• Modify sidebars.ts to insert the new document under the "Platform integrations" category so it appears with GitHub, GitLab, Azure DevOps, and Bitbucket.

Reasoning

I reviewed the entire docs/ folder and sidebars.ts to confirm the absence of any VS Code-specific content, researched the published extension IDs and URLs on both marketplaces, and collected CLI and configuration details for derivatives.

Proposed File Changes

📄 docs/platforms/vscode.md ^(NEW) 🔗

1. Add YAML frontmatter with title: VS Code Plugin, sidebar_label: VS Code, and a sidebar_position matching other platforms.
2. Create a top-level heading # VS Code Plugin.
3. Under ## Visual Studio Code (Marketplace), describe installing via Marketplace with code --install-extension CodeRabbit.coderabbit-vscode and link to https://marketplace.visualstudio.com/items?itemName=CodeRabbit.coderabbit-vscode.
4. Under ## VS Code Derivatives (Open VSX, VSCodium, OSS), cover:
   • codium --install-extension coderabbit.coderabbit-vscode
   • code-oss --install-extension coderabbit.coderabbit-vscode
   • settings.json snippet for Open VSX gallery configuration
   • Manual VSIX installation steps with download URL from https://open-vsx.org/extension/coderabbit/coderabbit-vscode
5. Include :::note and :::tip admonitions for compatibility and troubleshooting tips.

📄 sidebars.ts ^(MODIFY) 🔗

References

• 📄 docs/platforms/vscode.md

Locate the "Add CodeRabbit to your repository" category, then within its "Platform integrations" sub-category, add 'platforms/vscode' to the items array so the new VS Code page appears in the correct order alongside GitHub, GitLab, Azure DevOps, and Bitbucket.

Import In IDE

Developer Humor

🐇 Why did the rabbit hop into VS Code?
It heard installing our extension was a real hop-up! 🎉
Now it can debug faster than ever,
whether via Marketplace or Open VSX,
and never miss a 🥕 break! 🥳

---

Execution Information

Branch: main
Commit: b610174

---

💡 Tips

Supported Commands (Inside Comments)

• Use @traycerai generate to iterate on the previous version of the implementation plan.

Supported Commands (Inside Description)

• Add @traycerai ignore anywhere in the ticket description to prevent this ticket from being processed.
• Add @traycerai branch:<branch-name> anywhere in the ticket description to specify the target branch for the implementation plan.

Community

• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.