Skip to content

Add documentation for the VSCode extension #335

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.

Sign up for GitHub

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

Merged
merged 11 commits into from
May 14, 2025
Merged

Add documentation for the VSCode extension #335

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
3ff2069
Add about and use VSCode files
jmacdotorg May 12, 2025
e051a1a
Add further VSCode docs
jmacdotorg May 12, 2025
2022017
Remove unrelated ToC entries
jmacdotorg May 12, 2025
0c17e03
Various updates
jmacdotorg May 13, 2025
73436ea
Fix broken link.
jmacdotorg May 13, 2025
388ec8a
Removing spaces.
jmacdotorg May 13, 2025
a504ebe
Remove spaces for real this time.
jmacdotorg May 13, 2025
ba6b294
Add notes about Cursor and Windsurf. Other minor tweaks.
jmacdotorg May 13, 2025
b26e380
Just a little more clarity about non-VSCode editors.
jmacdotorg May 13, 2025
c5dbd69
s/several minutes/a few minutes/
jmacdotorg May 13, 2025
f4f9378
Merge branch 'main' into use-vscode
aravindputrevu May 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
s/several minutes/a few minutes/
  • Loading branch information
@jmacdotorg
jmacdotorg committed May 13, 2025
commit c5dbd69147faf16f1be84392031f0abdb2b2efad
4 changes: 2 additions & 2 deletions docs/guides/use-vscode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To perform an automatic review, follow these steps:

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**.
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).

Expand Down Expand Up @@ -52,7 +52,7 @@ To manually review changes in a local Git branch using the CodeRabbit VSCode ext

1. To perform the review, click the button part of the menu. The CodeRabbit sidebar displays a **Review** section with the review's progress.

1. Wait for the review to complete. This might take several minutes. To cancel a review in progress, click **Stop the review**.
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 the following section.

Expand Down