Skip to content

Add Chrome Extension documentation#588

Open
EliSchleifer wants to merge 3 commits intomainfrom
claude/add-extension-docs-JBMwV
Open

Add Chrome Extension documentation#588
EliSchleifer wants to merge 3 commits intomainfrom
claude/add-extension-docs-JBMwV

Conversation

@EliSchleifer
Copy link
Copy Markdown
Member

Summary

This PR adds comprehensive documentation for the Trunk Chrome Extension, a new feature that allows users to submit, cancel, and track Merge Queue pull requests directly from GitHub without leaving the PR page.

Changes

  • New documentation file: merge-queue/chrome-extension.md (121 lines)

    • Installation instructions with Chrome Web Store link and admin deployment guidance
    • Feature overview covering submission, cancellation, and real-time progress tracking
    • Detailed authentication and security model explaining session-based auth without credential storage
    • FAQ section addressing common questions about setup, visibility, browser compatibility, and comparison to /trunk merge comment
    • Placeholder comments for hero screenshots and feature screenshots
  • Updated navigation: Modified summary.md to add the new Chrome Extension page to the merge-queue documentation section, positioned between "Integration for Slack" and "Webhooks"

Notable Details

  • Documentation emphasizes that the extension is a companion UI to Trunk Merge Queue and requires an existing configured queue
  • Security section clearly explains the extension uses existing browser sessions at app.trunk.io with no separate credential storage
  • Includes guidance for Chrome admins to force-install the extension organization-wide using the Web Store ID

https://claude.ai/code/session_01Gjf9LGizwRF2HEW4w587yC

claude added 2 commits April 28, 2026 22:15
Documents the Trunk Chrome Extension that overlays merge queue controls
onto GitHub PR pages: install, submit, cancel, track testing progress,
plus a security note explaining session-based auth via app.trunk.io.
Image references are placeholders to be filled in once UI assets land.
Replaces the placeholder Chrome Web Store URL with the published
extension listing and notes that Chrome admins can force-install it
org-wide via the Google Workspace admin console.
@trunk-staging-io
Copy link
Copy Markdown

Merging to main in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

After your PR is submitted to the merge queue, this comment will be automatically updated with its status. If the PR fails, failure details will also be posted here

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Apr 28, 2026

Claude finished @EliSchleifer's task in 2m 2s —— View job


PR Review

  • Read CLAUDE.md for repo-specific guidelines
  • Review changed files for typos, grammar, formatting, and documentation best practices
  • Post inline comments for specific issues
  • Provide final review summary

Overall the documentation is well-structured and comprehensive. The content, security explanation, and FAQ section are clear and accurate. A few polish items to address:

Issues found (all non-blocking):

  1. Leftover TODO comments (lines 15, 30, 44, 57, 72) — Each `` comment appears immediately before an actual <figure> tag with an image already present. These stale comments should be removed.

  2. Empty alt text on all figures — Every <figure> uses alt="", which hurts accessibility. Descriptive alt text should be added to each image. Suggestions provided inline on lines 17, 32, 59.

  3. Missing captions on the Chrome Web Store install figure (line 32) and the Cancel figure (line 59) — both have empty <figcaption></figcaption>. Suggestions provided inline.

  4. Minor grammar (line 71) — "time spent in queue" → "time spent in the queue".

No typos, no broken internal links, no factual errors found. The navigation entry in summary.md is correctly placed.

Comment thread merge-queue/chrome-extension.md Outdated
The extension is a companion to Trunk Merge Queue — you still need a [configured queue](getting-started/) for your repository. The extension only surfaces controls and status for queues your Trunk organization already owns.
{% endhint %}

<!-- TODO: hero screenshot of the extension overlay on a GitHub PR page -->
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The `` comment should be removed — the actual <figure> with the image follows immediately on the next lines. Same pattern applies on lines 30, 44, 57, and 72.

Suggested change
<!-- TODO: hero screenshot of the extension overlay on a GitHub PR page -->


<!-- TODO: hero screenshot of the extension overlay on a GitHub PR page -->

<figure><img src="../.gitbook/assets/chrome-extension-overview.png" alt=""><figcaption>The Trunk overlay on a GitHub pull request page.</figcaption></figure>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

All <figure> tags in this file have empty alt="" attributes. Alt text is important for accessibility and should describe the image content.

Suggested change
<figure><img src="../.gitbook/assets/chrome-extension-overview.png" alt=""><figcaption>The Trunk overlay on a GitHub pull request page.</figcaption></figure>
<figure><img src="../.gitbook/assets/chrome-extension-overview.png"><figcaption>The Trunk overlay on a GitHub pull request page.</figcaption></figure>

Comment thread merge-queue/chrome-extension.md Outdated

<!-- TODO: screenshot of Chrome Web Store listing -->

<figure><img src="../.gitbook/assets/chrome-extension-install.png" alt=""><figcaption></figcaption></figure>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Both the alt attribute and caption are empty. Consider adding descriptive text.

Suggested change
<figure><img src="../.gitbook/assets/chrome-extension-install.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/chrome-extension-install.png"><figcaption>The Trunk Merge Queue extension in the Chrome Web Store.</figcaption></figure>

Comment thread merge-queue/chrome-extension.md Outdated

<!-- TODO: screenshot of the Cancel control in the extension panel -->

<figure><img src="../.gitbook/assets/chrome-extension-cancel.png" alt=""><figcaption></figcaption></figure>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Empty alt and empty caption — same issue as line 32. Please add descriptive text to both.

Suggested change
<figure><img src="../.gitbook/assets/chrome-extension-cancel.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/chrome-extension-cancel.png"><figcaption>Cancelling a PR from the merge queue via the extension panel.</figcaption></figure>

Comment thread merge-queue/chrome-extension.md Outdated
* **Tests Passed** — waiting for upstream PRs before merging
* **Merged**, **Failed**, or **Cancelled** — terminal states

The panel shows the current state, time spent in queue, and any upstream PRs whose results this PR depends on. A link jumps to the full PR detail page in the Trunk web app for deeper context.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Minor grammar: "time spent in queue" should be "time spent in the queue".

Suggested change
The panel shows the current state, time spent in queue, and any upstream PRs whose results this PR depends on. A link jumps to the full PR detail page in the Trunk web app for deeper context.
The panel shows the current state, time spent in the queue, and any upstream PRs whose results this PR depends on. A link jumps to the full PR detail page in the Trunk web app for deeper context.

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

Auto-approved: Claude code review passed.

Removes the redundant <!-- TODO --> comments above each figure (the
figure tags themselves serve as the placeholders), adds descriptive
figcaptions to the two install/cancel figures that were empty, and
fixes "in queue" → "in the queue" in the testing-progress section.
Keeps alt="" to match the existing repo convention.
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Apr 28, 2026

Claude finished @EliSchleifer's task in 43s —— View job


PR Review

  • Read CLAUDE.md for repo-specific guidelines
  • Review changed files for typos, grammar, formatting, and documentation best practices
  • Verify previous review feedback was addressed

All issues from the previous review have been resolved:

  • TODO comments removed ✅
  • Figcaptions filled in on all five figures ✅
  • Grammar fixed ("time spent in the queue") ✅
  • alt="" pattern is consistent with the rest of the docs repo ✅

The navigation entry in summary.md is correctly placed between "Integration for Slack" and "Webhooks". No remaining issues found.

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

Auto-approved: Claude code review passed.

@EliSchleifer EliSchleifer marked this pull request as ready for review April 28, 2026 22:57
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Apr 28, 2026

Claude finished @EliSchleifer's task in 59s —— View job


PR Review

  • Read CLAUDE.md for repo-specific guidelines
  • Review changed files for typos, grammar, formatting, and documentation best practices
  • Post inline comments for specific issues
  • Provide final review summary

This PR adds well-structured documentation for the Trunk Chrome Extension. All issues from previous review rounds have been resolved:

  • TODO comments removed ✅
  • Figcaptions filled in on all five figures ✅
  • Grammar fixed ("time spent in the queue") ✅
  • alt="" consistent with the rest of the docs repo ✅

Additional checks performed:

  • All internal links resolve correctly (getting-started/, optimizations/priority-merging.md, using-the-queue/reference.md#pull-request-states, ../setup-and-administration/security.md)
  • The #pull-request-states anchor matches the actual heading in reference.md
  • Navigation entry in summary.md is correctly placed between "Integration for Slack" and "Webhooks"
  • Content is accurate, the security model explanation is clear, and the FAQ covers the key user questions

No blocking issues found. Review passed.

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

Auto-approved: Claude code review passed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants