[ready to merge] docs(flaky-tests): Setup steps + Validate sections#26
Merged
Conversation
Convert "### Checklist" + bulleted `[ ]` items to a Mintlify `<Steps>` block with linked-title `<Step>` children across all 42 framework and CI-provider get-started pages. Each step jumps to the matching section on the page. Rename the heading to "Setup steps" and consolidate the surrounding prose into a single intro line that includes the next-step pointer. Add a "### Validate Your Uploads" section to all 13 CI provider pages so the final Setup step has a real link target. GitHub Actions gets a GitHub-specific version (workflow / action logs / repo secrets); the other 12 share a generic version pointing at app.trunk.io and the Uploads + Tests tabs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Member
Author
|
Verification status (2026-05-19): Verified: pure docs change with no eng dependency. Ready to publish.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
### Checklist+ bulleted[ ]pattern to a Mintlify<Steps>block with linked-title<Step>children across all 42 framework and CI-provider get-started pages. Rename the heading to Setup steps and consolidate the surrounding prose into a single intro line.### Validate Your Uploadssection to all 13 CI provider pages so the final Setup step has a real link target. GitHub Actions gets a GitHub-specific version (workflow / action logs / repo secrets); the other 12 share a generic version pointing at app.trunk.io and the Uploads + Tests tabs.Why
Mintlify wasn't rendering GitHub-flavored task-list syntax cleanly — bullets and checkboxes were doubling up visually.
<Steps>is the closest native Mintlify component for an ordered preview of section steps. It gives real numbered structure plus clickable jump-links to the matching section, which is what these "Checklist" sections were trying to be all along.Notes
<Step title="..." />accepts a string only — markdown link syntax inside the prop renders as literal[text](url). To get a clickable title, pass JSX:title={<a href="#anchor">text</a>}.Test plan
/flaky-tests/get-started/frameworks/cypress) — Setup steps renders as 4 numbered items, each title links to the matching section on the page./flaky-tests/get-started/ci-providers/github-actions— all 4 Setup steps link, including the new Validate Your Uploads anchor.circleci,gitlab) — Validate Your Uploads section renders correctly and the closing Tip block is still the page closer.flaky-tests/get-started/frameworks/rspec/index— the<Info>callout below the Steps block is preserved.