Add further VSCode docs

jmacdotorg · jmacdotorg · commit e051a1a3fceb · 2025-05-12T18:59:20.000-04:00
diff --git a/docs/guides/about-vscode.md b/docs/guides/about-vscode.md
@@ -1,5 +1,5 @@
 ---
-title: Overview
+title: VSCode extension overview
 description: How to review your code with the VSCode extension.
 ---
 
@@ -9,19 +9,23 @@ This page is about the CodeRabbit VSCode extension. For a broader overview of Co
 
 The CodeRabbit VSCode extension lets you apply a limited subset of CodeRabbit’s code-review features to your local development environment, directly from the VSCode IDE.
 
+The extension is intended to let you use the power of CodeRabbit to rapidly tune and tidy your code changes locally, before you publish your changes to your team's remote repository and start a more thorough code review.
+
 ## Features
 
 The extension includes the following features:
 
 - Automatic reviews of local Git commmits
 
-- Manually requested reviews of local code changes
+- Manually requested reviews of local code changes, either committed or uncommited
 
 ## Price and limitations
 
-This extension is free to install and use, and works with any tier of CodeRabbit account. You can use the extension on its own, or you can use it to complement your local development on a repository whose remote has CodeRabbit installed.
+This extension is free to install and use, and works with any tier of CodeRabbit account. Rate limits apply to the numnber of local reviews that you can request per hour.
+
+You can use the extension on its own, or you can use it to complement your local development on a repository whose remote has CodeRabbit installed.
 
-Rate limits apply to the numnber of local reviews that you can request per hour.
+As such, the extension makes only the most basic CodeRabbit review features available, with default settings applied. Advanced CodeRabbit features, such as interactive chat and project learnings, aren't available through the VSCode extension. These features are available only by [integrating CodeRabbit on your remote repository](/platforms), and then allowing CodeRabbit to review pull requests.
 
 ## What's next
 
diff --git a/docs/guides/install-vscode.md b/docs/guides/install-vscode.md
@@ -0,0 +1,43 @@
+---
+title: Install the VSCode extension
+description: How to install the CodeRabbit VSCode extension
+---
+
+This page is about installing the CodeRabbit VSCode extension. For more information about the extension, see
+[Overview](/guides/about-vscode).
+
+## Before you begin
+
+Before you can use the CodeRabbit VSCode extension, you need a CodeRabbit account.
+
+If you don't already have an account, you can create one by visiting [the CodeRabbit login page](https://app.coderabbit.ai/login).
+
+## Install the extension
+
+To install the CodeRabbit VSCode extension, follow these steps:
+
+1. Visit [the extension's page on the Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=CodeRabbit.coderabbit-vscode).
+
+1. Click **Install**.
+
+1. If your browser asks you for permission to open VSCode, then click **Allow** or its equivalent control.
+
+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. In VSCode, 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:
+
+   1. Click the CodeRabbit icon in the VSCode activity bar.
+
+   1. Click the **Use CodeRabbit for Free** button.
+
+1. Grant VSCode permission to open your browser, if asked.
+
+1. In your web browser, log into your CodeRabbit account.
+
+This connects your CodeRabbit account with the CodeRabit VSCode extension.
+
+## What's next
+
+- [Use the VSCode extension](/guides/use-vscode)
diff --git a/docs/guides/uninstall-vscode.md b/docs/guides/uninstall-vscode.md
@@ -0,0 +1,21 @@
+---
+title: Uninstall the VSCode extension
+description: How to uinstall the CodeRabbit VSCode extension
+---
+
+This page is about uninstalling the CodeRabbit VSCode extension. For more information about the extension, see
+[Overview](/guides/about-vscode).
+
+## Uninstall the extension
+
+To uninstall the VSCode extension, follow these steps:
+
+1. In the VSCode activity bar, click the CodeRabbit icon.
+
+1. In the CodeRabbit sidebar, click the door-shaped **Logout** icon.
+
+1. In the VSCode activity bar, click the **Extensions** icon.
+
+1. In the Extensions sidebar, click the gear-shaped **Manage** icon next to CodeRabbit in the list of installed extensions.
+
+1. Select **Uninstall**.
diff --git a/docs/guides/use-vscode.md b/docs/guides/use-vscode.md
@@ -6,7 +6,21 @@ description: How to review your code with the VSCode extension.
 This page is about using the CodeRabbit VSCode extension. For more information about the extension, see
 [Overview](/guides/about-vscode). To learn how to install the extension, see [Install the VSCode extension](/guides/install-vscode).
 
-## Review your code changes
+## Automatically review local commits
+
+You can let CodeRabbit automatically review commits that you make to your local Git repository. These automatic reviews compare all committed changes against the branch that your working branch is based on.
+
+To perform an automatic review, follow these steps:
+
+1. Perform a Git commit using VSCode. After you do this, a dialog appears in your VSCode window, asking **Would you like to start a review?**
+
+1. Click **Yes.** The CodeRabbit sidebar appears in your VSCode window.
+
+1. Wait for the review to complete. This might take several minutes. To cancel a review in progress, click **Stop the review**.
+
+For more options and control of code reviews performed using the CodeRabbit VSCode extension, you can manually request a review, as detailed in the following section.
+
+## Manually request code reviews
 
 To manually review changes in a local Git branch using the CodeRabbit VSCode extension, follow these steps:
 
@@ -36,4 +50,4 @@ To manually review changes in a local Git branch using the CodeRabbit VSCode ext
 
 ## What's next
 
-- The CodeRabbit [Introduction](/overview/introduction) describes how you can complement the CodeRabbit VSCode extension by setting up automatic, full-featured code reviews on your remote repository's pull requests.
+- [Uninstall the VSCode extension](/guides/install-extension)
diff --git a/docs/overview/introduction.md b/docs/overview/introduction.md
@@ -94,8 +94,16 @@ Public repositories can use the Pro tier of CodeRabbit at no charge, including a
 
 For private repositories, a number of pricing tiers are available. These range from a Free tier that offers unlimited code-change summaries, to an Enterprise tier with access to advanced features and SLA support. For more information, see [Pricing](https://www.coderabbit.ai/pricing).
 
+## Review local changes from within VSCode
+
+As a separate, free product, CodeRabbit offers a VSCode extension that brings a subset of core CodeRabbit features to VSCode. This lets you use the power of CodeRabbit to tune and tidy your code changes locally before pushing your changes into a formal pull request for more thorough reviews.
+
+For more information, see [About the VSCode extension](/guides/about-vscode).
+
 ## What's next
 
 - [Quickstart](/getting-started/quickstart/) lets you experience your first CodeRabbit code review first-hand.
 
+- [About the VSCode extension] guides you through installing and using a subset of CodeRabbit features directly from your code editor.
+
 - [Why CodeRabbit?](/overview/why-coderabbit) dives further into the philosophies and technologies that drive CodeRabbit.
diff --git a/sidebars.ts b/sidebars.ts
@@ -85,6 +85,8 @@ const sidebars: SidebarsConfig = {
 			label: "Review pull requests",
 			items: [
 				"guides/commands",
+				"guides/code-review-best-practices",
+				"guides/code-review-troubleshooting",
 				"guides/agent_chat",
 				{
 					type: "category",
@@ -108,6 +110,17 @@ const sidebars: SidebarsConfig = {
 				"guides/linked-issues",
 			],
 		},
+		{
+			type: "category",
+			collapsed: false,
+			label: "Review local changes using the VSCode extension",
+			items: [
+				"guides/about-vscode",
+				"guides/install-vscode",
+				"guides/use-vscode",
+				"guides/uninstall-vscode",
+			],
+		},
 		{
 			type: "category",
 			collapsed: false,
@@ -128,6 +141,7 @@ const sidebars: SidebarsConfig = {
 					label: "CodeRabbit API",
 					href: "https://api.coderabbit.ai/api/swagger/",
 				},
+				"reference/review-commands",
 				{
 					type: "category",
 					label: "Supported tools",
