From da4609030829c90f7cd79b389382f16cdfe4fa97 Mon Sep 17 00:00:00 2001 From: Jason McIntosh Date: Wed, 14 May 2025 16:13:56 -0400 Subject: [PATCH 1/2] Modify the installation instructions to prefer using the IDE's marketplace UI to insatll, rather than the website. --- docs/guides/install-vscode.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/guides/install-vscode.md b/docs/guides/install-vscode.md index 85e3e5e..3d4c5d5 100644 --- a/docs/guides/install-vscode.md +++ b/docs/guides/install-vscode.md @@ -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**. -1. Click **Install**. +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. If your browser asks you for permission to open VSCode, then click **Allow** or its equivalent control. +1. Select **CodeRabbit**. A summary of the CodeRabbit VSCode extension appears in the window's main pane, along with installation controls. -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. -1. In VSCode, click **Install**. +1. Click **Install**. 1. A **Log in to CodeRabbit to get started** dialog appears. Click **Login**. If the dialog gets dismissed or times out first, then you can follow these alternate steps: @@ -42,6 +42,12 @@ To install the CodeRabbit VSCode extension, follow these steps: This connects your CodeRabbit account with the CodeRabbit VSCode extension. +## Install using the marketplace website + +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 do install the extension this way, then you still need to connect your CodeRabbit account to the extension after installing it, as described in the previous section. + ## What's next - [Use the VSCode extension](/guides/use-vscode) From 47d254cdf0d133e3d5c2420499f3e8f189108c77 Mon Sep 17 00:00:00 2001 From: Jason McIntosh Date: Thu, 15 May 2025 15:23:54 -0400 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Ankit Jena --- docs/guides/install-vscode.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/guides/install-vscode.md b/docs/guides/install-vscode.md index 3d4c5d5..ddf5881 100644 --- a/docs/guides/install-vscode.md +++ b/docs/guides/install-vscode.md @@ -18,15 +18,15 @@ If you don't already have an account, you can create one by visiting [the CodeRa ## Install the extension -To install the CodeRabbit VSCode extension, follow these steps: +To install the CodeRabbit extension, follow these steps: -1. In the VSCode activity bar, click **Extensions**. +1. In the editor activity bar, click **Extensions**. 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. Select **CodeRabbit**. A summary of the CodeRabbit VSCode extension appears in the window's main pane, along with installation controls. -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. 1. Click **Install**.