Skip to content

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

using the IDE's marketplace UI to insatll,
rather than the website.
Copy link
Contributor

coderabbitai bot commented May 14, 2025

Walkthrough

The 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

File(s) Change Summary
docs/guides/install-vscode.md Revised installation instructions: replaced direct link method with in-app step-by-step guide, added separate section for marketplace website installation, reorganized content for clarity.

Assessment against linked issues

Objective Addressed Explanation
Clarify plugin installation differences between VSCode and derivatives (#338)

Poem

A hop through VSCode, step by step,
No more confusion, no more prep!
From search to click, install with glee,
Or use the web—just as easy as can be.
🐇✨

Tip

⚡️ Free AI Code Reviews for VS Code, Cursor, Windsurf
  • CodeRabbit now supports VS Code, Cursor and Windsurf. This brings free AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Learn more

[!ANNOUNCEMENT]

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches
  • 📝 Generate Unit Tests

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

Copy link

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: da46090
Status: ✅  Deploy successful!
Preview URL: https://8694656c.coderabbit-docs.pages.dev
Branch Preview URL: https://install.coderabbit-docs.pages.dev

View logs

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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, type coderabbit 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

📥 Commits

Reviewing files that changed from the base of the PR and between bd8a5f8 and da46090.

📒 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

@jmacdotorg jmacdotorg requested a review from ankitjena May 14, 2025 21:26
@@ -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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify plugin installation differences between VSCode and derivatives
2 participants