-
Notifications
You must be signed in to change notification settings - Fork 28
Modify the IDE installation instructions to prefer using the IDE's marketplace UI #341
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
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
Tip ⚡️ Free AI Code Reviews for VS Code, Cursor, Windsurf
✨ 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: |
da46090
|
Status: | ✅ Deploy successful! |
Preview URL: | https://8694656c.coderabbit-docs.pages.dev |
Branch Preview URL: | https://install.coderabbit-docs.pages.dev |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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, typecoderabbit
into 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
@@ -20,15 +20,15 @@ If you don't already have an account, you can create one by visiting [the CodeRa | |||
|
|||
To install the CodeRabbit VSCode extension, follow these steps: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To install the CodeRabbit VSCode extension, follow these steps: | |
To install the CodeRabbit extension, follow these steps: |
@@ -20,15 +20,15 @@ If you don't already have an account, you can create one by visiting [the CodeRa | |||
|
|||
To install the CodeRabbit VSCode extension, follow these steps: | |||
|
|||
1. Visit [the extension's page on the Visual Studio Marketplace](https://coderabbit.link/vscode-docs). | |||
1. In the VSCode activity bar, click **Extensions**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. In the VSCode activity bar, click **Extensions**. | |
1. In the editor activity bar, click **Extensions**. |
|
||
1. A summary of the CodeRabbit VSCode extension appears in your VSCode window. If you would like VSCode to automatically check for and apply future updates to the extension, then keep the **Auto Update** checkbox selected. | ||
1. If you would like VSCode to automatically check for and apply future updates to the extension, then keep the **Auto Update** checkbox selected. Otherwise, clear the checkbox. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. If you would like VSCode to automatically check for and apply future updates to the extension, then keep the **Auto Update** checkbox selected. Otherwise, clear the checkbox. | |
1. If you would like your editor to automatically check for and apply future updates to the extension, then keep the **Auto Update** checkbox selected. Otherwise, clear the checkbox. |
Staged:
Fixes #338