Skip to content

docs(flaky-tests): document quarantine status icons on repositories overview#553

Merged
trunk-staging-io[bot] merged 4 commits intomainfrom
sam-gutentag/flaky-tests-repos-overview-quarantine-icons
May 6, 2026
Merged

docs(flaky-tests): document quarantine status icons on repositories overview#553
trunk-staging-io[bot] merged 4 commits intomainfrom
sam-gutentag/flaky-tests-repos-overview-quarantine-icons

Conversation

@samgutentag
Copy link
Copy Markdown
Member

Summary

  • Adds a Repositories overview section to flaky-tests/dashboard.md
  • Documents the quarantine status icons introduced in trunk-io/trunk2#3538:
    • Shield icon: quarantining is enabled, auto-quarantine is off
    • Shield with checkmark icon: auto-quarantine is enabled
  • Includes full column reference for the repos overview table (Tests, Flaky, Broken, Runs/Day)
  • Links to the Quarantining page for configuration details

Source

Notes

This PR overlaps with #549 which documents the initial repos overview feature (trunk-io/trunk2#3527). One of the two should be updated to include the other's content before merging, or they can be merged in sequence with a follow-up cleanup.

Test plan

  • Preview in GitBook

…verview

The repositories overview now shows Shield (quarantining on, auto-quarantine
off) and ShieldCheck (auto-quarantine enabled) icons next to repo names.
Adds the full repositories overview section with column reference and icon
legend.

Source: trunk-io/trunk2#3538

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@trunk-staging-io
Copy link
Copy Markdown

trunk-staging-io Bot commented Apr 16, 2026

😎 Merged successfully - details.

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Apr 16, 2026

Claude finished @samgutentag's task in 1m 14s —— View job


Review Complete

  • Gather context (read CLAUDE.md and changed file)
  • Review for typos, grammar, and formatting issues
  • Review for documentation best practices
  • Post inline comments and final verdict

The new Repositories overview section is well-structured, clear, and fits naturally before the existing "Key repository metrics" section. Content is accurate and easy to follow. Two minor suggestions posted as inline comments:

  1. Line 22 — "hover tooltips" is slightly redundant; "per-day tooltips" is cleaner.
  2. Lines 28–29 — Icon table rows use inconsistent separators (; vs ); suggest standardizing to em dashes.

Neither is blocking. The section could benefit from a screenshot (other sections include figures), but that's a nice-to-have given this documents a new feature.

Comment thread flaky-tests/dashboard.md Outdated
Comment thread flaky-tests/dashboard.md Outdated
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.

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 5, 2026

Claude finished @samgutentag's task in 1m 1s —— View job


Review Complete

  • Read CLAUDE.md and changed file
  • Review diff for typos, grammar, and formatting
  • Check documentation best practices
  • Post final verdict

The new Repositories overview section is well-structured and accurate. Two minor issues from the previous review remain unaddressed, and one new observation:

1. Line 22 — redundant "hover" (flagged previously, not yet fixed)

Tooltips appear on hover by definition — "hover" is redundant here.

| **Runs / Day** | Bar chart of test run volume over the last 10 days, with per-day tooltips |

Fix this →

2. Lines 28–29 — inconsistent separators in icon table (flagged previously, not yet fixed)

Line 28 uses a semicolon (;) while line 29 uses an em dash (). These should be consistent.

| Shield | Quarantining is enabled for this repository — auto-quarantine is off |
| Shield with checkmark | Auto-quarantine is enabled — flaky tests are quarantined automatically |

Fix this →

3. No screenshot for icon descriptions (nice-to-have)

The section documents visual UI icons but has no <figure> block, while every other section in this file includes one. A screenshot showing the shield icons in context would help readers identify them in the UI. Not blocking.


Neither of the first two issues is blocking — they are minor style inconsistencies. The content is accurate, the structure is sound, and it fits naturally into the document.

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.

@samgutentag
Copy link
Copy Markdown
Member Author

Triage status (2026-05-05): up to date with main. Review approved. Ready to merge.

samgutentag and others added 2 commits May 6, 2026 10:54
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
@samgutentag samgutentag marked this pull request as ready for review May 6, 2026 17:54
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 6, 2026

Claude finished @samgutentag's task in 1m 4s —— View job


Review Complete

  • Read CLAUDE.md and changed file
  • Review diff for typos, grammar, and formatting
  • Check documentation best practices
  • Post final verdict

Both issues flagged in the previous review have been addressed:

  1. Line 22 — "hover" removed; now reads "with per-day tooltips" ✓
  2. Lines 28–29 — both rows now use em dashes consistently ✓

The content is accurate, prose is concise, the heading level (###) matches sibling sections, and the relative link [Quarantining](quarantining.md) resolves to an existing file.

Non-blocking observations

  • Table syntax inconsistency: every other table in flaky-tests/dashboard.md uses HTML <table> markup (with <thead>/<tbody> and column widths), while this PR adds two Markdown-pipe tables. Both render fine in GitBook, but converting to the HTML form would match the surrounding file style. Not blocking.
  • No screenshot for the icon section: every other section in this file has a <figure> block. A screenshot showing the shield icons in context would help readers identify them in the UI. Already flagged previously as a nice-to-have.
  • PR overlap with docs(flaky-tests): document repositories overview landing page #549: per the PR description, this overlaps with another PR documenting the same repos overview. Worth confirming the merge order with the author of docs(flaky-tests): document repositories overview landing page #549 before merging.

Verdict

No blocking issues. The diff is clean, content is accurate, and prior review feedback has been incorporated. Ready to merge.
| Branch

@trunk-staging-io trunk-staging-io Bot merged commit 539c4e1 into main May 6, 2026
5 of 8 checks passed
@trunk-staging-io trunk-staging-io Bot deleted the sam-gutentag/flaky-tests-repos-overview-quarantine-icons branch May 6, 2026 17:55
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