Skip to content

Commit 9118578

Browse files
committed
Add the IDE config page to the ToC. Rename the file, since the ToC didn't like the original name for some reason.
1 parent f3de573 commit 9118578

File tree

4 files changed

+14
-7
lines changed

4 files changed

+14
-7
lines changed

docs/guides/configure-vscode.md renamed to docs/guides/config-vscode.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The instructions on this page are specific to using the extension with VSCode. I
1212

1313
## Find the settings screen {#find}
1414

15-
To navigate to the the settings screen for the CodeRabbit VSCode extension, follow these steps:
15+
To navigate to the settings screen for the CodeRabbit VSCode extension, follow these steps:
1616

1717
1. In the activity bar, click the Extensions icon.
1818

@@ -46,7 +46,7 @@ The **Auto Review Mode** setting lets you control the behavior of the automatic
4646

4747
- **Auto**: The extension always performs a review after every commit.
4848

49-
For more information about this feature, see [Automatically review local commits](/guides/use-vscode#auto).
49+
For more information about this feature, see [Automatically review local commits](/guides/use-vscode#auto-reviews).
5050

5151
## Set a review timeout {#timeout}
5252

@@ -56,4 +56,6 @@ To turn off timeouts, set this value to `0`.
5656

5757
## What's next {#whats-next}
5858

59-
- [Uninstall the VSCode extension](/guides/use-vscode)
59+
- [Use the VSCode extension](/guides/use-vscode)
60+
61+
- [Uninstall the VSCode extension](/guides/uninstall-vscode)

docs/guides/install-vscode.md

+2
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,5 @@ This connects your CodeRabbit account with the CodeRabbit VSCode extension.
4545
## What's next
4646

4747
- [Use the VSCode extension](/guides/use-vscode)
48+
49+
- [Configure the VSCode extension](/guides/config-vscode)

docs/guides/use-vscode.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ To perform an automatic review, follow these steps:
2020

2121
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?**
2222

23-
1. Click **Yes.** The CodeRabbit sidebar appears in your VSCode window.
23+
1. Click **Yes**. The CodeRabbit sidebar appears in your VSCode window.
2424

2525
1. Wait for the review to complete. This might take a few minutes. To cancel a review in progress, click **Stop the review**.
2626

2727
After the review completes, you can browse and respond to review comments as described in [Work with code reviews](#work-with-code-reviews).
2828

29-
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/configure-vscode#auto-reviews).
29+
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).
3030

3131
For more control of code reviews performed using the CodeRabbit VSCode extension, you can manually request a review, as detailed in the following section.
3232

@@ -78,15 +78,15 @@ If you agree with CodeRabbit about the suggested fix and want to apply to exactl
7878

7979
### Request help from your AI coding agent {#agent}
8080

81-
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 request assistance from the AI coding agent associated with your IDE, click this icon.
81+
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.
8282

8383
Depending upon your IDE and the current extension settings, the extension performs one of the following actions:
8484

8585
- If you are using VSCode with Copilot installed, then the extension can send the request directly to Copilot.
8686
- If you have Claude Code installed, then the extension can send the request to the `claude` command-line program.
8787
- 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.
8888

89-
For more information about configuring this behavior, see [Configure AI agent integration](/guides/configure-vscode#agent).
89+
For more information about configuring this behavior, see [Configure AI agent integration](/guides/config-vscode#agent).
9090

9191
### Ignore or collapse comments {#ignore}
9292

@@ -104,4 +104,6 @@ If a past review comment no longer applies to the current state of your code, th
104104

105105
## What's next {#whats-next}
106106

107+
- [Configure the VSCode extension](/guides/config-vscode)
108+
107109
- [Uninstall the VSCode extension](/guides/uninstall-vscode)

sidebars.ts

+1
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ const sidebars: SidebarsConfig = {
116116
"guides/about-vscode",
117117
"guides/install-vscode",
118118
"guides/use-vscode",
119+
"guides/config-vscode",
119120
"guides/uninstall-vscode",
120121
],
121122
},

0 commit comments

Comments
 (0)