create a clearer hierarchy for install instructions#284
Conversation
eshaben
changed the title
🤖 kluster.ai PR Review Summary⚡ Review this PR in 1/10 of the time — Try our new AI-powered code review experience 📋 PR SummaryThis PR updates the installation documentation for various IDEs and editors, adding section headers to improve readability. The changes organize the installation instructions into clear steps, including "Install", "Log in", and "Enable", making it easier for users to follow along. The updates maintain the existing content while enhancing its presentation. ✅ All ClearNo issues detected in this PR.
Powered by kluster.ai - Real-Time AI code review in your IDE |
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the “Get started with Code Reviews” installation guide to present a clearer, more consistent step hierarchy across supported IDE extensions and terminal tools.
Changes:
- Added explicit subsection labels (e.g., Install, Log in, Enable) to improve scannability within editor-specific instructions.
- Reformatted the standalone CLI install instructions into platform tabs (macOS/Linux/WSL vs Windows PowerShell).
- Standardized minor copy/formatting (e.g., punctuation in “Next steps”).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
🤖 kluster.ai PR Review Summary⚡ Review this PR in 1/10 of the time — Try our new AI-powered code review experience 📋 PR SummaryThis PR improves the installation documentation for various IDEs and code editors by adding clear section headings ("Install", "Log in", and "Enable") to guide users through the setup process. The changes enhance the readability and structure of the installation instructions, making it easier for users to follow along. The documentation now provides a more streamlined and user-friendly experience across different platforms, including VS Code, Cursor, JetBrains, Visual Studio, Windsurf, Antigravity, and CLI. ✅ All ClearNo issues detected in this PR.
Powered by kluster.ai - Real-Time AI code review in your IDE |
Bundles the terminology and platform-UI-label fixes from the original follow-up branch into one commit on top of post-#284 main: - Capitalize "Repo Reviews" (capital R, capital R) when referring to the product, dashboard, screen, results, or features. - Keep lowercase "repo review/reviews" only for the activity of reviewing a repository. - Capitalize "PR Reviews" / "PR Review" as the product name. - Use "PR Review bot" (capital P, capital R, lowercase bot) for the bot itself; replace older "PR bot" references in changelog entries. - Keep lowercase "PR review" only for activity references (e.g., "every PR review runs at the ultra-deep level"). - Update platform UI label "PR Bot Installation" -> "PR Bot Configuration" across the four PR Reviews integration pages. Files updated: changelogs.md, cli/repo-reviews.md, cli/review-commands.md, faq.md, get-started/pick-your-workflow.md, pr-reviews/{azure-devops, bitbucket, github, gitlab, quickstart}.md, repo-reviews/quickstart.md, review-modes.md, troubleshooting.md. The Visual Studio install tab Windows ARM correction lives in a separate commit since installation.md was restructured by #284 and needs manual re-application. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…inux Visual Studio itself does not run on macOS (discontinued in 2024) or Linux, so the previous wording was misleading. The actual platform constraint is that the kluster.ai extension does not support Windows ARM, only Windows x64. Re-applied on top of post-#284 main, which had restructured installation.md with a clearer hierarchy. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* Sweep: capitalize Repo Reviews and PR Review bot product references Bundles the terminology and platform-UI-label fixes from the original follow-up branch into one commit on top of post-#284 main: - Capitalize "Repo Reviews" (capital R, capital R) when referring to the product, dashboard, screen, results, or features. - Keep lowercase "repo review/reviews" only for the activity of reviewing a repository. - Capitalize "PR Reviews" / "PR Review" as the product name. - Use "PR Review bot" (capital P, capital R, lowercase bot) for the bot itself; replace older "PR bot" references in changelog entries. - Keep lowercase "PR review" only for activity references (e.g., "every PR review runs at the ultra-deep level"). - Update platform UI label "PR Bot Installation" -> "PR Bot Configuration" across the four PR Reviews integration pages. Files updated: changelogs.md, cli/repo-reviews.md, cli/review-commands.md, faq.md, get-started/pick-your-workflow.md, pr-reviews/{azure-devops, bitbucket, github, gitlab, quickstart}.md, repo-reviews/quickstart.md, review-modes.md, troubleshooting.md. The Visual Studio install tab Windows ARM correction lives in a separate commit since installation.md was restructured by #284 and needs manual re-application. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Correct Visual Studio platform prerequisite: Windows ARM, not macOS/Linux Visual Studio itself does not run on macOS (discontinued in 2024) or Linux, so the previous wording was misleading. The actual platform constraint is that the kluster.ai extension does not support Windows ARM, only Windows x64. Re-applied on top of post-#284 main, which had restructured installation.md with a clearer hierarchy. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Description
This pull request improves the structure and clarity of the installation instructions for multiple supported editors and tools in the
code-reviews/get-started/installation.mddocumentation. The main changes introduce consistent, clearly labeled steps for installing, logging in, and enabling the kluster.ai integration across all supported platforms. Additionally, section headings and step descriptions have been standardized, and minor copy edits have been made for consistency.Restructured installation steps for all supported editors and tools:
Added explicit Install, Log in, and Enable section headers for each supported IDE/editor (VS Code, Cursor, JetBrains, Visual Studio, Windsurf, Antigravity, CLI), making the setup process easier to follow. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13]
Standardized alternative login instructions, updating headers to "Alternative log in: with an API key" for JetBrains and Visual Studio sections. [1] [2]
Formatting and consistency improvements:
Checklist
kluster-mkdocsrepo