Skip to content

Update with docs about new flake detection configuration#453

Open
mmatheson wants to merge 2 commits intomainfrom
matt/flake-detection-docs
Open

Update with docs about new flake detection configuration#453
mmatheson wants to merge 2 commits intomainfrom
matt/flake-detection-docs

Conversation

@mmatheson
Copy link
Member

No description provided.

@trunk-staging-io
Copy link

trunk-staging-io bot commented Mar 9, 2026

✨ Submitted to Merge by github-actions[bot]. It will be added to the merge queue once all branch protection rules pass and there are no merge conflicts with the target branch. See more details here.

@claude
Copy link

claude bot commented Mar 9, 2026

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


PR Review: Update with docs about new flake detection configuration

  • Gather context
  • Read new documentation files
  • Review for typos, grammar, and formatting
  • Post inline comments
  • Final summary

Summary

This PR reorganizes flake detection documentation from a single detection.md file into a structured detection/ directory with dedicated pages per monitor type. The content is well-written, logically organized, and technically accurate. Link updates across 50+ framework/CI provider files are consistent and correct.

Findings

Minor issues (non-blocking):

  1. Screenshot placeholders — HTML comment blocks (``) remain in 3 new files as developer notes for where screenshots should be added:

    • detection/README.md (1 block)
    • detection/pass-on-retry-monitor.md (1 block)
    • detection/threshold-monitor.md (3 blocks)

    These don't render to users, but should be removed if screenshots won't be added before publishing. See inline comments →

  2. Trailing space in code block titleuploader.md line 120 has {% code %} with a trailing space. Fix suggested →

What looks good

  • The monitor architecture (additive model, muting, events) is clearly explained with helpful Mermaid diagrams
  • Branch pattern syntax table and examples in threshold-monitor.md are thorough and accurate
  • Recommended configurations section provides practical, actionable guidance
  • All links from detection.mddetection/ have been updated correctly; no broken links remain
  • flag-as-flaky.md cleanly replaces the removed manual monitor concept

No blocking issues found.

<!-- SCREENSHOT: Mute button and duration picker on the test case monitor list.
Show the test case detail page with a monitor's mute button visible,
and ideally the duration picker dropdown open. -->

Copy link

Choose a reason for hiding this comment

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

These `` comment blocks appear throughout the new detection docs as placeholder notes for future screenshots. HTML comments won't render to users, but they add noise to the source. If screenshots will be added before publishing, these are fine to keep temporarily — otherwise they should be removed.

<!-- SCREENSHOT: Pass-on-Retry monitor configuration panel.
Show the monitor settings UI with the enabled toggle and recovery days
slider/input. Capture a state where the monitor is enabled with the
default 7-day recovery period visible. -->
Copy link

Choose a reason for hiding this comment

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

Same screenshot placeholder note as in README.md — consider removing if screenshots won't be added before this is published.

stale timeout, and branch scope. Capture it with realistic example
values filled in (e.g., "Main branch flake detector", 30% activation,
15% recovery, 6 hour window, 50 min sample, main branch). -->

Copy link

Choose a reason for hiding this comment

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

Screenshot placeholder comment — same note as other files. Three of these exist in this file (lines 29–35, 143–147, 209–214). Remove if screenshots won't be added before publishing.

{% endtabs %}

### Variants

Copy link

Choose a reason for hiding this comment

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

Trailing space in the code block title: "Upload an iOS variant " — should be "Upload an iOS variant".

Suggested change
{% code %}

@github-actions
Copy link

github-actions bot commented Mar 9, 2026

/trunk merge

Copy link

@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.

1 participant