Modify the IDE installation instructions to prefer using the IDE's marketplace UI #341
Conversation
using the IDE's marketplace UI to insatll, rather than the website.
|
""" WalkthroughThe installation guide for the CodeRabbit VSCode extension was updated to provide a clearer, step-by-step process for installing the extension directly from within VSCode. An alternative section for installing via the marketplace website was added, distinguishing between official VSCode and derivative editors. Changes
Assessment against linked issues
Poem
✨ Finishing Touches
🪧 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 (
|
Deploying coderabbit-docs with
|
| Latest commit: |
47d254c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://0277474b.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://install.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 (2)
docs/guides/install-vscode.md (2)
23-31: Add missing article in instruction step
The phrase “In sidebar” is missing the article “the”. For consistency and clarity, update it to “In the sidebar”.@@ -25 +25 - 1. In sidebar, type `coderabbit` into the **Search Extensions in Marketplace** search bar. After a moment, **CodeRabbit** appears in the sidebar as a search result. + 1. In the sidebar, type `coderabbit` into the **Search Extensions in Marketplace** search bar. After a moment, **CodeRabbit** appears in the sidebar as a search result.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: You might be missing the article “the” here.
Context: ...ivity bar, click Extensions. 1. In sidebar, typecoderabbitinto the **Search Ex...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
45-49: Capitalize and clarify Marketplace section title
Use the official product name “Visual Studio Marketplace” in the heading and text for precision and consistency.@@ -45 +45 -## Install using the marketplace website +## Install using the Visual Studio Marketplace @@ -47 +47 -If you are using the VSCode IDE, and not an IDE that derives from it such as Cursor or Windsurf, then you can alternatively obtain and install the CodeRabbit VSCode extension by visiting [the extension's page on the Visual Studio Marketplace](https://coderabbit.link/vscode-docs). +If you are using the official VSCode IDE (and not a derivative such as Cursor or Windsurf), you can alternatively install the CodeRabbit VSCode extension by visiting the [Visual Studio Marketplace page](https://coderabbit.link/vscode-docs).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/guides/install-vscode.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/guides/install-vscode.md
[uncategorized] ~25-~25: You might be missing the article “the” here.
Context: ...ivity bar, click Extensions. 1. In sidebar, type coderabbit into the **Search Ex...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Cloudflare Pages
Co-authored-by: Ankit Jena <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/guides/install-vscode.md (1)
25-25: Minor grammar improvement: add missing article.Change “In sidebar, type
coderabbitinto the Search Extensions in Marketplace search bar.” to “In the sidebar, typecoderabbitinto the Search Extensions in Marketplace search bar.” for grammatical consistency.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: You might be missing the article “the” here.
Context: ...ivity bar, click Extensions. 1. In sidebar, typecoderabbitinto the **Search Ex...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/guides/install-vscode.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/guides/install-vscode.md
[uncategorized] ~25-~25: You might be missing the article “the” here.
Context: ...ivity bar, click Extensions. 1. In sidebar, type coderabbit into the **Search Ex...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: test
- GitHub Check: Cloudflare Pages
🔇 Additional comments (2)
docs/guides/install-vscode.md (2)
21-31: Clear, step-by-step installation instructions implemented.The updated instructions for installing the extension from within VSCode’s Extensions view are concise, logical, and align precisely with the PR’s goal of preferring the IDE’s built-in marketplace UI. This greatly improves clarity and user experience.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: You might be missing the article “the” here.
Context: ...ivity bar, click Extensions. 1. In sidebar, typecoderabbitinto the **Search Ex...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
45-49: Approve alternative marketplace website section.The new “Install using the marketplace website” section cleanly separates the secondary path for official VSCode users without cluttering the main flow. It clearly reminds users to reconnect their account afterward.
Staged:
Fixes #338