Add documentation for the VSCode extension #335
Conversation
WalkthroughThis update introduces comprehensive documentation for the CodeRabbit VSCode extension, including a conceptual overview, installation and uninstallation guides, and a detailed usage how-to. The introduction is updated to reference the VSCode extension, and the sidebar is expanded to include a new "Review local changes" section grouping these guides. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant VSCode
participant CodeRabbit Extension
User->>VSCode: Install CodeRabbit Extension
VSCode->>CodeRabbit Extension: Activate extension
User->>CodeRabbit Extension: Log in to CodeRabbit
CodeRabbit Extension-->>User: Authentication dialog
User->>CodeRabbit Extension: Make code changes
User->>VSCode: Commit changes (optional)
alt Automatic Review
VSCode->>CodeRabbit Extension: Detect commit
CodeRabbit Extension-->>User: Prompt to review changes
User->>CodeRabbit Extension: Start review (or cancel)
else Manual Review
User->>CodeRabbit Extension: Request manual review
CodeRabbit Extension-->>User: Select base branch and changes to review
end
CodeRabbit Extension->>User: Display review comments and suggestions
User->>CodeRabbit Extension: Apply suggestions, ignore, or collapse comments
Assessment against linked issues
Poem
Tip ⚡️ Faster reviews with caching
Enjoy the performance boost—your workflow just got faster. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (2)
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (12)
docs/overview/introduction.md (2)
97-102: Unify link trailing slash for consistency
Internal links elsewhere include a trailing slash (e.g.,/getting-started/quickstart/). For consistency, please add a trailing slash to/code-editors.Apply this diff:
## 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 [Review local changes](/code-editors). +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 [Review local changes](/code-editors/).
105-108: Unify link trailing slash in "What's next"
The new bullet uses/code-editorswithout a trailing slash. Align it with other links by adding/at the end.Apply this diff:
## What's next - [Quickstart](/getting-started/quickstart/) lets you experience your first CodeRabbit code review first-hand. -- [Review local changes](/code-editors) guides you through installing and using a subset of CodeRabbit features directly from your code editor. +- [Review local changes](/code-editors/) 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.docs/guides/uninstall-vscode.md (1)
13-22: Vary sentence structure in steps for clarity
Three consecutive steps start with "In …", which can feel repetitive. Consider rephrasing to begin with the action verb, and reorder phrases for readability.Example diff:
-1. In the VSCode activity bar, click the CodeRabbit icon. +1. Click the CodeRabbit icon in the VSCode activity bar. -1. In the CodeRabbit sidebar, click the door-shaped **Logout** icon. +1. Click the door-shaped **Logout** icon in the CodeRabbit sidebar. -1. In the VSCode activity bar, click the **Extensions** icon. +1. Click the **Extensions** icon in the VSCode activity bar. -1. In the Extensions sidebar, click the gear-shaped **Manage** icon next to CodeRabbit in the list of installed extensions. +1. Click the gear-shaped **Manage** icon next to CodeRabbit in the Extensions sidebar. -1. Select **Uninstall**. +1. Click **Uninstall**.🧰 Tools
🪛 LanguageTool
[style] ~17-~17: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ck the door-shaped Logout icon. 1. In the VSCode activity bar, click the **Ex...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~19-~19: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...bar, click the Extensions icon. 1. In the Extensions sidebar, click the gear-...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/guides/install-vscode.md (3)
35-35: Remove unnecessary comma
There's no need for a comma before "if" in this context.-1. Grant VSCode permission to open your browser, if asked. +1. Grant VSCode permission to open your browser if asked.🧰 Tools
🪛 LanguageTool
[typographical] ~35-~35: Usually, there’s no comma before “if”.
Context: ...t VSCode permission to open your browser, if asked. 1. In your web browser, log int...(IF_NO_COMMA)
7-7: Unify link trailing slash
For consistency with other guides, include a trailing slash on the internal link.-For more information about the extension, see -[Review local changes](/code-editors). +For more information about the extension, see +[Review local changes](/code-editors/).
1-4: Add explicitslugandsidebar_labelfor consistency
Other guides defineslugandsidebar_labelin their frontmatter to control URL paths and sidebar navigation. Consider adding these fields here.--- title: Install the VSCode extension description: How to install the CodeRabbit VSCode extension +slug: /guides/install-vscode +sidebar_label: Install ---docs/guides/about-vscode.md (1)
2-5: Adjustsidebar_labelfor clarity
Under the "Review local changes" category, labeling this page as "Overview" may be ambiguous. Consider using a more descriptive label like "About the VSCode extension."--- title: Review local changes description: How to review your code with the VSCode extension. slug: /code-editors -sidebar_label: Overview +sidebar_label: About the VSCode extension ---docs/guides/use-vscode.md (5)
9-9: Clarify "full-branch changes" phrasing
The term "full-branch changes" can be confusing. Consider replacing it with "full-branch reviews" (or "review all committed changes") for clarity.Proposed diff:
- You can use the extension to automatically perform full-branch changes after every commit, or make different kinds of comparisons by manually requesting a review. + You can use the extension to automatically perform full-branch reviews after every commit, or make different kinds of comparisons by manually requesting a review.
19-19: Bold punctuation outside labels
Move the period outside the bold in the button label so it's unambiguous.- 1. Click **Yes.** The CodeRabbit sidebar appears in your VSCode window. + 1. Click **Yes**. The CodeRabbit sidebar appears in your VSCode window.
49-49: Remove unnecessary "of" for conciseness
Replace "all of the files" with "all the files".- Refer to the list of **Files to review** in the sidebar. This list represents all of the files that the selected review action includes. + Refer to the list of **Files to review** in the sidebar. This list represents all the files that the selected review action includes.🧰 Tools
🪛 LanguageTool
[style] ~49-~49: Consider removing “of” to be more concise
Context: ...** in the sidebar. This list represents all of the files that the selected review action i...(ALL_OF_THE)
76-80: Reduce repetitive sentence beginnings
Three back-to-back sentences start with "To". Consider varying the third for better flow. For example:- To see an ignored or collapsed comment in the editor again, click its summary in the CodeRabbit sidebar. + Once hidden, you can view a collapsed or ignored comment again by clicking its summary in the CodeRabbit sidebar.🧰 Tools
🪛 LanguageTool
[style] ~80-~80: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...presence, click its Collapse icon. To see an ignored or collapsed comment in ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
85-85: Use "before" instead of "prior to"
Swap the wordy "prior to" for the simpler "before".- 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 you have performed reviews before the most recent review in the current VSCode window, you can browse those comments under the **Previous reviews** heading in the CodeRabbit sidebar.🧰 Tools
🪛 LanguageTool
[style] ~85-~85: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... reviews If you have performed reviews prior to the most recent review in the current V...(EN_WORDINESS_PREMIUM_PRIOR_TO)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
docs/guides/about-vscode.md(1 hunks)docs/guides/install-vscode.md(1 hunks)docs/guides/uninstall-vscode.md(1 hunks)docs/guides/use-vscode.md(1 hunks)docs/overview/introduction.md(1 hunks)sidebars.ts(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/guides/install-vscode.md
[typographical] ~35-~35: Usually, there’s no comma before “if”.
Context: ...t VSCode permission to open your browser, if asked. 1. In your web browser, log int...
(IF_NO_COMMA)
docs/guides/use-vscode.md
[style] ~49-~49: Consider removing “of” to be more concise
Context: ...** in the sidebar. This list represents all of the files that the selected review action i...
(ALL_OF_THE)
[style] ~80-~80: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...presence, click its Collapse icon. To see an ignored or collapsed comment in ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~85-~85: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... reviews If you have performed reviews prior to the most recent review in the current V...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
docs/guides/uninstall-vscode.md
[style] ~17-~17: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ck the door-shaped Logout icon. 1. In the VSCode activity bar, click the **Ex...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~19-~19: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...bar, click the Extensions icon. 1. In the Extensions sidebar, click the gear-...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: fix
- GitHub Check: Cloudflare Pages
🔇 Additional comments (3)
sidebars.ts (1)
111-121: Verify existence of referenced guide
The new sidebar category referencesguides/use-vscode, but I don’t seedocs/guides/use-vscode.mdin this PR. Please confirm that the file exists with the correct frontmatter (slug, sidebar_label) to avoid broken links.docs/guides/use-vscode.md (2)
1-4: Ensure frontmatter meets project conventions
Verify that the YAML frontmatter (title,description) aligns with your docs site setup. If your Docusaurus configuration—or whatever static-site generator you use—expects additional keys (e.g.,sidebar_label,slug, orsidebar_position), please add them here.
7-7: Verify link target for "Review local changes"
The link[Review local changes](/code-editors)may not point to the intended overview page (often/guides/about-vscode). Please confirm that/code-editorsexists or update it to the correct path.
Deploying coderabbit-docs with
|
| Latest commit: |
a504ebe
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://084c1c0d.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://use-vscode.coderabbit-docs.pages.dev |
|
|
||
| - To limit the review to only changes on your branch that you have committed, select **Review committed changes**. This includes commits that you have pushed to your remote repository, if any, as well as any local commits. | ||
|
|
||
| - To limit the review to only uncommitted changes on your branch, select **Review uncommitted changes**. |
There was a problem hiding this comment.
| - To limit the review to only uncommitted changes on your branch, select **Review uncommitted changes**. | |
| - To limit the review to only uncommitted(both staged/unstaged) changes on your branch, select **Review uncommitted changes**. |
|
|
||
| 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). |
There was a problem hiding this comment.
Kindly add this short link https://coderabbit.link/vscode-docs
Fixes #329 Fixes #330 Fixes #327 Fixes #328 Fixes #321
Staged: