Document the "Fix with AI" feature (#342)

Author: jmacdotorg

docs/guides/config-vscode.md

@@ -0,0 +1,61 @@
+---
+title: Configure the VSCode extension
+description: How to configure the CodeRabbit VSCode extension
+---
+
+This page is about configuring the CodeRabbit VSCode extension. For more information about the extension, see
+[Review local changes](/code-editors).
+
+:::note
+The instructions on this page are specific to using the extension with VSCode. If you are instead using a VSCode-compatible editor such as Cursor or Windsurf, then the steps that you need to follow are similar, but might require some adaptation.
+:::
+
+## Find the settings screen {#find}
+
+To navigate to the settings screen for the CodeRabbit VSCode extension, follow these steps:
+
+1. In the activity bar, click the Extensions icon.
+
+1. In the sidebar, under **Installed**, click the gear-shaped **Manage** icon in the CodeRabbit row.
+
+1. In the menu that appears, select **Settings**.
+
+The settings screen contains the following configuration controls.
+
+## Configure AI agent integration {#agent}
+
+The **Agent Type** setting lets you choose the extension's response to using the **Fix with AI** feature during code reviews. Your options are the following:
+
+- **Native**: The extension prompts the AI agent associated with your IDE to apply the suggested fix.
+
+  This works only with VSCode, using Copilot. If you have this option selected when using a different IDE, then the extension instead copies the prompt to your clipboard.
+
+- **Claude Code**: The extension opens the Terminal pane of your IDE and tries to use the `claude` command-line program to apply the suggested fix to your code. You need to have Claude Code installed for this option to be effective.
+
+- **Clipboard**: The extension copies prompt text describing the suggested fix to your clipboard. From there, you can manually paste the prompt into the coding AI agent that you use with your IDE.
+
+For more information about the **Fix with AI** feature, see [Request help from your AI coding agent](/guides/use-vscode#agent).
+
+## Configure automatic review behavior {#auto-reviews}
+
+The **Auto Review Mode** setting lets you control the behavior of the automatic code reviews that the extension can perform after you make commits to your local Git repository. Your options are the following:
+
+- **Disabled**: The extension doesn't perform automatic code reviews.
+
+- **Prompt**: After every commit, the extension displays a dialog asking if you'd like it to perform a code review.
+
+- **Auto**: The extension always performs a review after every commit.
+
+For more information about this feature, see [Automatically review local commits](/guides/use-vscode#auto-reviews).
+
+## Set a review timeout {#timeout}
+
+The **Review Timeout** setting lets you specify how long the extension waits for a response from CodeRabbit remote servers before timing out a code review. The default value is `20`.
+
+To turn off timeouts, set this value to `0`.
+
+## What's next {#whats-next}
+
+- [Use the VSCode extension](/guides/use-vscode)
+
+- [Uninstall the VSCode extension](/guides/uninstall-vscode)

docs/guides/install-vscode.md

@@ -45,3 +45,5 @@ This connects your CodeRabbit account with the CodeRabbit VSCode extension.
 ## What's next
 
 - [Use the VSCode extension](/guides/use-vscode)
+
+- [Configure the VSCode extension](/guides/config-vscode)

docs/guides/use-vscode.md

@@ -12,23 +12,25 @@ The CodeRabbit VSCode extension works by comparing changes in your current, chec
 The instructions on this page are specific to using the extension with VSCode. If you are instead using a VSCode-compatible editor such as Cursor or Windsurf, then the steps that you need to follow are similar, but might require some adaptation.
 :::
 
-## Automatically review local commits
+## Automatically review local commits {#auto-reviews}
 
 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. Click **Yes**. The CodeRabbit sidebar appears in your VSCode window.
 
 1. Wait for the review to complete. This might take a few minutes. To cancel a review in progress, click **Stop the review**.
 
-After the review completes, you can browse and respond to review comments as described in [Work with code reviews](#work-with-code-reviews).
+After the review completes, you can browse and respond to review comments as described in [Work with code reviews](#work).
 
-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.
+You can optionally configure the extension to either always or never perform automatic code reviews on commit, instead of displaying this yes-or-no dialog. For more information, see [Configure automatic review behavior](/guides/config-vscode#auto-reviews).
 
-## Manually request code reviews
+For more 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 {#manual-reviews}
 
 To manually review changes in a local Git branch using the CodeRabbit VSCode extension, follow these steps:
 
@@ -56,38 +58,52 @@ To manually review changes in a local Git branch using the CodeRabbit VSCode ext
 
 After the review completes, you can browse and respond to review comments as described in the following section.
 
-## Work with code reviews
+## Work with code reviews {#work}
 
 The CodeRabbit VSCode extension presents code reviews as a series of actionable comments, connected to specific files and lines. It gives you tools to apply its suggestions quickly, when possible.
 
-### Browse comments
+### Browse comments {#browse}
 
 After the extension finishes its review, it adds any comments to the CodeRabbit sidebar under the **Files** heading in the **Reviews** section.
 
 Each item in **Files** is a comment referring to one or more lines in that file. Click the comment to see a detailed, inline comment in the editor, attached to the appropriate file and lines.
 
 You can react to these comments however you want: you can apply their advice literally, or let them guide you to find alternate solutions, or ignore them entirely. CodeRabbit comments are metadata stored with VSCode, and are not part of your files. The presence of comments doesn't block your use of version control.
 
-### Apply suggested changes
+### Apply suggested changes {#apply}
 
 Whenever possible, the CodeRabbit VSCode extension attaches discrete change suggestion to comments in the form of code diffs. For example, if it detects a typo in a new function name, the extension might attach a diff with a suggested correction.
 
 If you agree with CodeRabbit about the suggested fix and want to apply to exactly as it proposes, click the checkmark-shaped **Apply suggested change** icon in the inline comment. The extension makes the change for you in the editor.
 
-### Ignore or collapse comments
+### Request help from your AI coding agent {#agent}
+
+If CodeRabbit determines that an AI coding agent could help with resolving one of its comments, then it adds a star-shaped **Fix with AI** icon to the inline display of that comment. To have the extension generate a request for an AI agent to address the comment, click this icon.
+
+Depending upon your IDE and the current extension settings, the extension performs one of the following actions:
+
+- If you are using VSCode with Copilot installed, then the extension can send the request directly to Copilot.
+- If you have Claude Code installed, then the extension can send the request to the `claude` command-line program.
+- As a fallback, the extension can copy the request, phrased as an AI prompt, to your clipboard. You can then manually paste this prompt into the coding AI of your IDE.
+
+For more information about configuring this behavior, see [Configure AI agent integration](/guides/config-vscode#agent).
+
+### Ignore or collapse comments {#ignore}
 
 To remove a comment from the editor, click its **Ignore** icon.
 
 To remove a comment but keep an icon in the editor noting its presence, click its **Collapse** icon.
 
 To see an ignored or collapsed comment in the editor again, click its summary in the CodeRabbit sidebar.
 
-### Browse previous reviews
+### Browse previous reviews {#previous}
 
 If you have performed reviews prior to the most recent review in the current VSCode window, then you can browse the comments from these reviews under the **Previous reviews** heading in the CodeRabbit sidebar.
 
 If a past review comment no longer applies to the current state of your code, then clicking that comment won't display a detailed comment or suggestion in the editor.
 
-## What's next
+## What's next {#whats-next}
+
+- [Configure the VSCode extension](/guides/config-vscode)
 
 - [Uninstall the VSCode extension](/guides/uninstall-vscode)

sidebars.ts

@@ -116,6 +116,7 @@ const sidebars: SidebarsConfig = {
 				"guides/about-vscode",
 				"guides/install-vscode",
 				"guides/use-vscode",
+				"guides/config-vscode",
 				"guides/uninstall-vscode",
 			],
 		},