Fixed: Write a best-practices guide for using the VSCode extension #331 #411
Conversation
WalkthroughA new documentation guide detailing best practices for using the VSCode extension was added. The sidebar configuration was updated to include this new guide under the "Review local changes" category. No code or public API changes were made. Changes
Sequence Diagram(s)Not applicable: Only documentation and sidebar configuration were changed. Assessment against linked issues
Poem
✨ Finishing Touches
🧪 Generate Unit Tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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 (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/guides/best-practices-vscode.md (2)
48-56: Minor wording & grammar polishTwo quick tweaks improve clarity and remove LanguageTool warnings:
-**Avoid large, monolithic commits** -Break up big changes into logical units. This speeds up reviews and improves feedback accuracy. +**Avoid large, monolithic commits** +Break large changes into logical units. This speeds up reviews and improves feedback accuracy. @@ -**Use `.coderabbitignore`** -Exclude files or directories you don’t want reviewed to reduce clutter and speed up analysis. +**Use `.coderabbitignore`** +Exclude files or directories you don’t want CodeRabbit to review. This reduces clutter and speeds up analysis.
10-17: Consistent UI reference formattingThe arrow notation is helpful, but it deviates from the rest of the docs that typically wrap commands/settings in back-ticks only. For example, consider:
-→ Use `CodeRabbit: Base Branch` in the Command Palette. +Use the **“CodeRabbit: Set Base Branch”** command from the Command Palette.Same for the auto-review toggle. This aligns with prevailing style and screen-reader friendliness.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/guides/best-practices-vscode.md(1 hunks)sidebars.ts(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/guides/best-practices-vscode.md
[uncategorized] ~49-~49: Possible missing preposition found.
Context: ...Avoid large, monolithic commits Break up big changes into logical units. This...
(AI_HYDRA_LEO_MISSING_TO)
[style] ~49-~49: The word ‘big’ tends to be overused. Consider an alternative.
Context: ...arge, monolithic commits** Break up big changes into logical units. This speeds up revi...
(BIG_DIFFERENCE)
[uncategorized] ~55-~55: Possible missing preposition found.
Context: ...nce. - Use .coderabbitignore Exclude files or directories you don’t want rev...
(AI_HYDRA_LEO_MISSING_TO)
🔇 Additional comments (1)
sidebars.ts (1)
125-133: Validate placement & naming for the new sidebar entryAdding
guides/best-practices-vscodeunder “Review local changes” is logical, but it slightly overlaps conceptually with the global “Best practices” category that already exists below (lines 149-154). If discoverability is a concern, consider either:
- Moving the doc into the existing Best practices bucket, or
- Keeping it here but renaming the sidebar label to something more action-oriented like “VSCode best practices”.
Either way, double-check that duplicated content doesn’t confuse readers.
fixes: #331
requester: @jmacdotorg
Summary
This PR introduces new documentation pages focused on ebest-practices guide for using the VSCode extension
Details
Motivation
To improve usability and support coverage by documenting known pitfalls and offering actionable tips. These pages help developers quickly self-diagnose problems and adopt workflows that maximize CodeRabbit’s value.
Reviewer Notes