Skip to content

[TRUNK-17581] Improve Merge Queue API reference with examples and cross-links#439

Open
samgutentag wants to merge 2 commits intomainfrom
sam/merge-queue-api-docs-improvements
Open

[TRUNK-17581] Improve Merge Queue API reference with examples and cross-links#439
samgutentag wants to merge 2 commits intomainfrom
sam/merge-queue-api-docs-improvements

Conversation

@samgutentag
Copy link
Member

@samgutentag samgutentag commented Feb 17, 2026

Summary

Improves the Merge Queue public API reference page with better discoverability, practical guidance, and cross-linking to related documentation.

Changes

  • Endpoint summary table — Quick-reference table listing all 10 API endpoints with anchor links for fast navigation
  • Common use cases section — Practical guidance for CI/CD automation, monitoring dashboards, queue state management, parallel queue configuration, and test monitoring
  • Authentication section — Expanded auth docs including forked PR authentication via x-forked-workflow-run-id header
  • Additional curl examples — Added PR status check example alongside existing submit/cancel examples; fixed request body format to use proper pr.number field
  • Endpoint descriptions — Added contextual descriptions for getSubmittedPullRequest, setImpactedTargets, getMergeQueueTestingDetails, and deleteQueue
  • Related resources section — Links to CLI reference, parallel queues API, webhooks, queue settings, and authentication docs
  • Consistent formatting — Horizontal rules between sections, proper heading hierarchy

Related

Test plan

  • Verify OpenAPI spec blocks render correctly in GitBook preview
  • Confirm anchor links in endpoint summary table resolve to correct sections
  • Check cross-reference links to CLI reference, parallel queues, webhooks, and settings pages
  • Verify collapsible example blocks render properly
  • Confirm the deleteQueue warning hint renders correctly
  • Verify forked PR auth info hint renders as an info block

samgutentag and others added 2 commits February 17, 2026 13:56
Rewrites the API reference with better structure, common request
fields docs, descriptive section intros, and practical curl examples
for all endpoint categories. Adds cross-references between API
reference, settings page, and submit/cancel page.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ference

Enhances the Merge Queue API reference page with a quick-reference endpoint
summary table, common use cases section, forked PR authentication guidance,
additional curl examples for PR status checks, and a related resources section
linking to CLI reference, parallel queues, webhooks, and settings docs.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@samgutentag samgutentag changed the title Improve Merge Queue API reference with examples and cross-links [TRUNK-17581] Improve Merge Queue API reference with examples and cross-links Feb 18, 2026
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.

1 participant