Skip to content

Add screenshot placeholders and restructure token setup documentation#281

Merged
albertov19 merged 9 commits intomainfrom
alberto/screenshots-and-faq
Apr 17, 2026
Merged

Add screenshot placeholders and restructure token setup documentation#281
albertov19 merged 9 commits intomainfrom
alberto/screenshots-and-faq

Conversation

@albertov19
Copy link
Copy Markdown
Collaborator

Description

This pull request updates the documentation for providing feedback on code reviews and clarifies the setup steps for integrating kluster.ai with Bitbucket and GitLab. The changes focus on making instructions more user-friendly, adding visual aids, and clarifying the distinctions between different token creation methods.

Feedback workflow improvements:

  • Expanded the FAQ on providing feedback by detailing step-by-step instructions for submitting feedback from both the IDE and the kluster.ai platform, and added illustrative screenshots for each method.

Bitbucket integration instructions:

  • Clarified the difference between creating a standard API token and a scoped API token, recommending the standard method for most users, and provided a new section with step-by-step instructions and screenshots for both methods.
  • Updated the instructions for copying and handling the Bitbucket API token, emphasizing that the token is only shown once, and added a tip about when to use the scoped token method.

GitLab integration instructions:

  • Updated the GitLab integration guide to reflect the new token creation interface, specifying to use the "Generate token" button and to select the "Legacy token" type, with added screenshots for clarity.

Checklist

  • Required - I have added a label to this PR 🏷️
  • Required - I have run my changes through Grammarly
  • If pages have been moved, I have created redirects in the kluster-mkdocs repo

albertov19 and others added 6 commits April 16, 2026 17:02
Add TODO placeholders at the steps where users are most likely to get
stuck during token creation:

GitLab (2 screenshots):
- Step 3: Legacy vs Fine-grained token type selection dropdown
- Step 4: Token form with name, expiration, and required scopes

Bitbucket (2 screenshots):
- Step 4: Product selection page with Bitbucket chosen
- Step 5: Scopes page with all 14 required permissions checked

Images will be added as .webp files in a follow-up commit once the
screenshots are taken.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Replace the vague one-liner about feedback with two concrete paths:

- IDE: open Recent Reviews in the extension sidebar, click a review,
  use thumbs up/down on individual issues
- Platform: open Review History, click a review, use the Your Feedback
  section with Yes/No rating and optional comments

Add screenshot placeholders for both the IDE feedback buttons and the
platform Your Feedback section.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add two screenshots to the GitLab "Create an access token" section:

- Step 3: Token type selection dropdown showing Legacy token vs
  Fine-grained token (Beta)
- Step 4: Legacy token form with name, expiration date, and required
  scopes (api, read_api, read_user) selected

Remove TODO placeholder comments now that the actual images are in
place.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Bitbucket offers two API token methods, similar to GitLab's Legacy vs
Fine-grained distinction. Restructure the "Create an API token"
section to:

- Make "Create API token" (simple) the primary recommended path:
  name + expiration + Create. No scope selection needed.
- Move "Create API token with scopes" into a collapsed details block
  with the full 4-step wizard (name/expiry, select app, select
  scopes, create) and the 14-scope reference table
- Add 1 screenshot placeholder for the simple path (API Tokens page
  showing both creation options)
- Match the GitLab page pattern: recommended path visible, alternative
  collapsed

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add screenshot to step 3 of the simple "Create API token" path showing
the creation dialog with name, expiration date, and Create button.
Remove the TODO placeholder comment.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add two screenshots to the "How can I provide feedback" FAQ entry:

- IDE: Review Details panel showing an expanded issue with thumbs
  up/down feedback buttons alongside Snooze and Ignore actions
- Platform: Review History detail page showing the Your Feedback
  section with Yes/No rating buttons and optional comments field

Remove TODO placeholder comments now that the actual images are in
place.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@albertov19 albertov19 added A2 - Maintenance Minor Pull request contains minor updates to an existing page (i.e., modifying parameters, steps, etc.) B1 - Ready to Merge Pull request is ready to be merged labels Apr 17, 2026
Copilot AI review requested due to automatic review settings April 17, 2026 21:08
@albertov19 albertov19 added the C2 - High High priority task label Apr 17, 2026
@kluster-ai
Copy link
Copy Markdown

kluster-ai bot commented Apr 17, 2026

🤖 kluster.ai PR Review Summary

Review this PR in 1/10 of the time — Try our new AI-powered code review experience

📋 PR Summary

This PR updates documentation for kluster.ai code reviews and integrations with Bitbucket and GitLab. It clarifies how to provide feedback on code review results from the IDE or kluster.ai platform, and adds instructions for creating API tokens for Bitbucket and GitLab, including screenshots to illustrate the process. The changes aim to improve user understanding of how to interact with kluster.ai's code review features and how to set up integrations with their version control platforms.

✅ All Clear

No issues detected in this PR.


⚠️ Warning: We haven't found any reviews performed on this branch from the IDE. Make sure to install the IDE and CLI integrations to catch issues earlier and accelerate your development workflow.

Powered by kluster.ai - Real-Time AI code review in your IDE

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates kluster.ai Code Reviews documentation to make feedback workflows clearer and to reflect updated token-creation flows for Bitbucket and GitLab, adding supporting screenshots.

Changes:

  • Expanded FAQ instructions for submitting review feedback from both the IDE and the kluster.ai platform, with screenshots.
  • Restructured Bitbucket API token setup to distinguish “standard” vs “scoped” token creation, with an alternative scoped-token section and screenshots.
  • Updated GitLab token setup steps to match the newer token UI and added screenshots.

Reviewed changes

Copilot reviewed 3 out of 8 changed files in this pull request and generated 3 comments.

File Description
code-reviews/pr-reviews/gitlab.md Updates Legacy token creation step wording and adds screenshots for token type selection + scope selection.
code-reviews/pr-reviews/bitbucket.md Reworks token creation section into recommended “standard token” path + alternative scoped-token wizard path, adding a screenshot.
code-reviews/faq.md Adds step-by-step feedback instructions for IDE and platform, with screenshots.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread code-reviews/pr-reviews/gitlab.md
Comment thread code-reviews/pr-reviews/gitlab.md
Comment thread code-reviews/pr-reviews/bitbucket.md Outdated
albertov19 and others added 3 commits April 17, 2026 21:13
The Legacy path says "click Generate token" but the fine-grained
alternative still referenced "Add new token". Update to "Generate
token" so both paths use the same button label matching the current
GitLab UI.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Prerequisites and the section intro said "with the api scope" while
step 4 listed all three (api, read_api, read_user). Update both
locations to list all three scopes so the requirement is consistent
throughout the page.

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
Copy link
Copy Markdown

kluster-ai bot commented Apr 17, 2026

🤖 kluster.ai PR Review Summary

Review this PR in 1/10 of the time — Try our new AI-powered code review experience

📋 PR Summary

This PR updates documentation for kluster.ai, focusing on improving instructions for providing feedback on code reviews and creating API tokens for Bitbucket and GitLab integrations. It enhances the FAQ by detailing how to provide feedback from both the IDE and the kluster.ai platform, with accompanying screenshots. The PR reviews documentation for Bitbucket and GitLab is also updated to clarify the process of creating API tokens, including the recommended methods and alternative approaches, along with new images to illustrate the steps. These changes aim to make the setup and usage of kluster.ai more straightforward and user-friendly.

✅ All Clear

No issues detected in this PR.


⚠️ Warning: We haven't found any reviews performed on this branch from the IDE. Make sure to install the IDE and CLI integrations to catch issues earlier and accelerate your development workflow.

Powered by kluster.ai - Real-Time AI code review in your IDE

@albertov19 albertov19 merged commit 51f6b1d into main Apr 17, 2026
6 of 7 checks passed
@albertov19 albertov19 deleted the alberto/screenshots-and-faq branch April 17, 2026 21:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A2 - Maintenance Minor Pull request contains minor updates to an existing page (i.e., modifying parameters, steps, etc.) B1 - Ready to Merge Pull request is ready to be merged C2 - High High priority task

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants