Document the "Fix with AI" feature #342
Conversation
… the "Fix with AI" feature.
…dn't like the original name for some reason.
## Walkthrough
A new documentation guide for configuring the VSCode extension was added, detailing available settings and their functions. Existing guides were updated with section anchors, clarified explanations, and expanded instructions on AI agent integration. The sidebar was updated to include the new configuration guide, and cross-references were added between related guides.
## Changes
| File(s) | Change Summary |
|----------------------------------------------|------------------------------------------------------------------------------------------------|
| docs/guides/config-vscode.md | Added a new guide explaining how to configure the CodeRabbit VSCode extension and its settings.|
| docs/guides/install-vscode.md | Updated "What's next" section to include a link to the new configuration guide. |
| docs/guides/use-vscode.md | Added section anchors, clarified configuration explanations, and documented AI agent integration.|
| sidebars.ts | Inserted the new configuration guide into the documentation sidebar navigation. |
## Sequence Diagram(s)
```mermaid
sequenceDiagram
participant User
participant VSCode Extension
participant AI Agent (Copilot/Claude/Clipboard)
User->>VSCode Extension: Clicks "Fix with AI" on comment
alt Copilot available
VSCode Extension->>AI Agent (Copilot): Sends request for fix
else Claude CLI available
VSCode Extension->>AI Agent (Claude): Sends request for fix via CLI
else Clipboard mode
VSCode Extension->>User: Copies prompt text to clipboard
endAssessment against linked issues
Poem
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/guides/config-vscode.md (1)
17-21: Reduce repetitive sentence openings
Three consecutive list items begin with "In the…", which can feel monotonous. Consider varying the phrasing for better readability.Proposed diff:
-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**. +1. Click the Extensions icon in the activity bar. +2. Under **Installed**, click the gear-shaped **Manage** icon for CodeRabbit. +3. Select **Settings** from the context menu.🧰 Tools
🪛 LanguageTool
[style] ~21-~21: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...anage** icon in the CodeRabbit row. 1. In the menu that appears, select **Setting...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🛑 Comments failed to post (1)
docs/guides/use-vscode.md (1)
27-27:
⚠️ Potential issueFix broken anchor link for "Work with code reviews"
The link uses#work-with-code-reviews, but the section is anchored as{#work}. Update the link to[#work]or rename the anchor for consistency.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
27-27: Link fragments should be valid
null(MD051, link-fragments)
🤖 Prompt for AI Agents
In docs/guides/use-vscode.md at line 27, the anchor link for "Work with code reviews" is broken because the link uses #work-with-code-reviews but the actual section anchor is #work. Fix this by either updating the link to use #work or renaming the section anchor to #work-with-code-reviews for consistency.
Deploying coderabbit-docs with
|
| Latest commit: |
ba839e6
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4dc33005.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://ai-button.coderabbit-docs.pages.dev |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/guides/use-vscode.md (1)
31-31: Add context for manual review section
Consider converting this reference into an explicit link to improve discoverability.For example:
- For more control of code reviews performed using the CodeRabbit VSCode extension, you can manually request a review, as detailed in the following section. + For more control of code reviews performed using the CodeRabbit VSCode extension, see [Manually request code reviews](#manual-reviews) in the following section.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/guides/use-vscode.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/guides/use-vscode.md
[style] ~96-~96: 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] ~101-~101: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...revious} If you have performed reviews prior to the most recent review in the current V...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: test
- GitHub Check: Cloudflare Pages
🔇 Additional comments (10)
docs/guides/use-vscode.md (10)
15-15: Add anchor to Automatic Reviews section
Introducing{#auto-reviews}on the “Automatically review local commits” heading enhances navigability and enables deep-linking.Please verify that the corresponding section in
docs/guides/config-vscode.mduses the exact sameauto-reviewsanchor.
23-23: Clarify automatic review prompt step
The updated step “Click Yes. The CodeRabbit sidebar appears in your VSCode window.” reads clearly and maintains the consistent “1.”-style list.
27-27: Update cross-reference to Work section
The link to[Work with code reviews](#work)correctly matches the{#work}anchor on the target heading.
29-29: Link to configuration guide for auto-review behavior
Great addition directing users to configure automatic review modes.Ensure that
docs/guides/config-vscode.mddefines a section with{#auto-reviews}so this link resolves properly.
33-33: Add manual review section with anchor
The new## Manually request code reviews {#manual-reviews}heading and anchor provide clear structure for users who prefer manual review flows.
79-79: Introduce AI coding agent help section
The “Request help from your AI coding agent” subsection clearly explains the “Fix with AI” feature. The{#agent}anchor will aid in linking from other docs.
89-89: Link to AI agent configuration guide
This link to[Configure AI agent integration](/guides/config-vscode#agent)is essential.Please confirm that
docs/guides/config-vscode.mdincludes a matching{#agent}anchor so this deep link works as intended.
105-105: Add "What's next" section with anchor
The new## What's next {#whats-next}heading provides a logical wrap-up and deep-linking capability.
107-107: Include Configure VSCode extension in next steps
Adding the “Configure the VSCode extension” link here ensures users can immediately access setup instructions for AI agent integration and automatic review preferences.
109-109: Include Uninstall VSCode extension in next steps
Retaining the uninstall link under “What’s next” offers a complete navigation path for users evaluating or troubleshooting the extension.
Also, document the IDE extension settings screen.
Staged:
Fixes #339 Fixes #340