Add PR Reviews nav, permissions warnings, uninstall commands, and rules#273
Conversation
…es clarification - Uncomment PR Reviews section in sidebar navigation - Add prominent permissions warning admonition to GitLab and Bitbucket PR Reviews pages (account needs Developer access, not just token scopes) - Add uninstall sections to all IDE and terminal tool tabs in installation page - Clarify Azure DevOps custom rules note and add "For supported providers" qualifier to step 3 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
albertov19
added
the
A2 - Maintenance Minor
albertov19
added
B1 - Ready to Merge
🤖 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 documentation for Code Reviews to improve clarity and provide additional information on installation, configuration, and usage. The changes include adding uninstall instructions for various IDEs and tools, clarifying the requirements for API tokens and account permissions in Bitbucket and GitLab integrations, and making minor adjustments to the navigation menu. The updates aim to provide a more comprehensive and user-friendly experience for developers using Code Reviews. ✅ 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
Documentation updates to improve PR Reviews discoverability, clarify provider limitations for rules, and make setup/teardown steps more explicit.
Changes:
- Enabled the “PR Reviews” section in the sidebar navigation.
- Added permission warnings for GitLab and Bitbucket PR Reviews token setup (account role requirements).
- Added uninstall instructions across IDE and terminal installation tabs; clarified Azure DevOps rule support limitations.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
code-reviews/pr-reviews/gitlab.md |
Adds a prominent warning about required GitLab account role for token-based setup. |
code-reviews/pr-reviews/bitbucket.md |
Adds a prominent warning about required Bitbucket account permissions for token-based setup. |
code-reviews/get-started/installation.md |
Adds uninstall guidance for each IDE/terminal tab and points to CLI uninstall docs. |
code-reviews/configuration/rules.md |
Clarifies Azure DevOps rule limitations and scopes “Add review rule” to supported providers. |
.nav.yml |
Makes “PR Reviews” visible in the global navigation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Enterprise note now appears before the tip, consistent with GitHub, GitLab, Bitbucket, and Azure DevOps pages. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Update prerequisites from Basic access to Project Administrator or Project Collection Administrator. Add warning admonition about silent webhook failure. Add troubleshooting section with step-by-step fix. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Goes with papermoonio/kluster-mkdocs#169 |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
🤖 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 documentation for kluster.ai's Code Reviews feature, specifically focusing on PR Reviews. It makes PR Reviews visible in the navigation menu and adds a note indicating that this feature is exclusive to the Enterprise plan. The documentation now includes more detailed instructions for setting up PR Reviews with various Git providers, such as Azure DevOps, Bitbucket, GitHub, and GitLab, including required permissions and troubleshooting tips. Additionally, the PR adds uninstall instructions for kluster.ai integrations with different IDEs and tools, improving the overall user experience by providing clearer guidance on both setup and removal processes. ✅ All ClearNo issues detected in this PR.
Powered by kluster.ai - Real-Time AI code review in your IDE |
Remove ambiguous "Project Administrator or Project Collection Administrator" wording — the fix requires Project Collection Administrators specifically per the support case. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.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 updates the documentation for kluster.ai's Code Reviews feature, specifically focusing on PR Reviews. It makes PR Reviews visible in the navigation menu and adds information about its availability on the Enterprise plan. The changes also include updates to the installation guides for various IDEs and CLIs, adding uninstallation instructions. Additionally, the PR updates the PR Reviews documentation for different Git providers (Azure DevOps, Bitbucket, GitHub, and GitLab) to clarify permission requirements and troubleshooting steps. The changes aim to improve the overall user experience and provide more comprehensive guidance on using Code Reviews. 🔍 Issues DetectedFound 1 issue(s) in this PR
Powered by kluster.ai - Real-Time AI code review in your IDE |
![kluster-ai[bot]](https://avatars.githubusercontent.com/in/2988314?s=60&v=4){kind=small}
| - A personal access token with the required scopes. See [Create a personal access token](#create-a-personal-access-token) for instructions. | ||
|
|
||
| !!! warning "Verify account permissions" | ||
| The account that generates the personal access token must be a member of **Project Collection Administrators**. Having the correct token scopes is not enough — the account itself needs this role to install webhooks. If the account has insufficient permissions, webhook installation will fail silently and pull request reviews will not appear. To fix this, navigate to **Organization Settings** > **Security** > **Permissions**, find the user, and add them to **Project Collection Administrators**. After updating permissions, click **Re-install** on the PR Reviews page in the kluster.ai platform to complete the setup. |
There was a problem hiding this comment.
🤖 kluster.ai · 🟡 semantic · medium
Description: The new requirement for Project Collection Administrators conflicts with the existing documentation claim that all team members can connect their projects.
Explanation: The new warning explicitly requires the user connecting the project to be a Project Collection Administrator because installing webhooks demands this elevated role in Azure DevOps. However, the unedited "Admin consent" note directly below it still promises that "all team members in the organization can connect their projects without repeating this step". If setting up the project requires administrator permissions, normal team members cannot complete the setup.
Recommended Action: The "Admin consent" section should be updated to clarify that only Project Collection Administrators can connect projects, replacing the claim about all team members.
Issue Actions:
Description
This pull request updates the documentation for code reviews with several improvements focused on clarity, usability, and completeness. The main changes include adding explicit uninstall instructions for all supported editors and tools, clarifying rule support for Azure DevOps, updating navigation, and providing important warnings about required permissions when setting up PR reviews for Bitbucket and GitLab.
Uninstallation instructions for all supported editors and tools:
Configuration and permissions clarifications:
Navigation improvements:
.nav.yml, making it visible and accessible.Checklist
kluster-mkdocsrepo