Skip to content

docs(flaky-tests): publish the test collections pages - #330

Draft
TylerJang27 wants to merge 5 commits into
test-collections/api-referencefrom
test-collections/flip
Draft

docs(flaky-tests): publish the test collections pages#330
TylerJang27 wants to merge 5 commits into
test-collections/api-referencefrom
test-collections/flip

Conversation

@TylerJang27

@TylerJang27 TylerJang27 commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Important

This is the launch switch — land it last, and only after the default test_collection_status enum is flipped. Merging this makes the test collections documentation publicly visible in the navigation.

Overview

PR 6, the last of the Test Collections docs stack: unhides the concept page and the migration guide and gives each a navigation entry.

Details

Stacked on #329#325#324#323. Everything below has to land first, or this publishes navigation entries pointing at pages whose supporting edits are not in yet.

Three files: the two pages lose hidden: true, and docs.json gains two nav entries plus three redirects.

Considerations

  • The concept page goes first in Getting Started, not below the framework pages. The plan had it above Multiple Repositories and Forks, which would have buried it under roughly forty framework and CI-provider entries. It moved because docs(flaky-tests): make collections the default in the straggler copy #324 changed that group's own index to tell readers to verify uploads on their collection's Uploads tab and to open the collection's Monitors tab — so the page explaining what a collection is has to be reachable before the pages that assume it.
  • Both collections pages sit together at the top of Getting Started — the concept page, then the migration guide, then the framework and CI-provider pages. The migration guide started in Overview on the reasoning that it targets existing organizations rather than new setup; grouping it with the concept page reads better, since the two are read together. Its file stays at the top level, which matches dashboard sitting at the top level inside the Overview group.
  • No new redirects. An earlier revision added three for paths a reader might guess; they were removed, because nothing links to any of them and none has ever been a live path, so there was no link rot for them to prevent. /flaky-tests/test-collections already redirects to the concept page and that one is real — the page has lived there.
  • Nothing else in the flaky-tests tree is hidden, so this publishes exactly these two pages and no unrelated drafts.

Testing

Verified against a local build rather than by inspection:

  • mint validate (strict) passes; mint broken-links reports none across the whole stack.
  • Confirmed both pages now appear in the built navigation by fetching a rendered page and finding their entries — the specific thing this PR exists to do, and the thing a passing build would not otherwise prove.
  • Confirmed the pre-existing redirect still resolves: /flaky-tests/test-collections returns 307 to /flaky-tests/get-started/test-collections.

Follow-up Work

Outside this stack, and worth tracking:

  • The webhook-emission control's label on the migration guide is written generically, because no UI reads testCollectionWebhooksEnabledDuringMigration yet. Tighten it once that ships.
  • The v2 spec in docs(flaky-tests): publish the v2 API and split the reference by scope #329 is a copied file and will drift; automating the copy is a small job worth doing.
  • mint dev / mint validate are not run in CI here. Mintlify's own check only builds PRs targeting main, so a stacked PR gets no preview — worth considering a workflow that runs the CLI on every PR regardless of base.

References

🤖 Generated with Claude Code

TylerJang27 and others added 5 commits September 9, 2026 19:10
The launch switch. Drops `hidden: true` from the concept page and the
migration guide, and gives each a navigation entry.

The concept page goes **first** in Getting Started rather than below the
forty-odd framework and CI-provider pages: that group's own index now
tells a reader to verify uploads on their collection's Uploads tab and to
open the collection's Monitors tab, so it has to be reachable before the
setup pages it precedes.

The migration guide sits in Overview beside the dashboard. It is for
organizations that already use Flaky Tests, so filing it under Getting
Started would imply it is part of new-user setup, and it is the page with
the highest traffic during the migration window.

Three redirects for paths a reader will guess — `/flaky-tests/collections`,
`/flaky-tests/migration`, `/flaky-tests/migrate` — alongside the
`/flaky-tests/test-collections` redirect that already existed.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Removes `/flaky-tests/collections`, `/flaky-tests/migration` and
`/flaky-tests/migrate`. Nothing links to any of them — not the product,
not the docs — and none has ever been a live path, so there is no link
rot for them to prevent. A redirect earns its place by preserving a URL
that used to work; these were guesses at what a reader might type, and
a speculative redirect can never be removed later because nobody can
prove it is unused.

`/flaky-tests/test-collections` stays: the concept page has lived at
that path, so that one is real.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Moves it out of Overview, so both collections pages sit together at the
top of Getting Started: the concept page, then the migration guide, then
the framework and CI-provider setup pages.

The file stays at `flaky-tests/migrate-to-test-collections.mdx`. Nav
group and directory already diverge elsewhere in this tree — `dashboard`
sits at the top level inside the Overview group — so there is no
consistency gained by moving it, and the page has never been live at
another URL to redirect from.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Test Collections moves to Overview, and the two files move with their
groups so the layout on disk says what the navigation says:

  flaky-tests/test-collections.mdx                      (Overview)
  flaky-tests/get-started/migrate-to-test-collections.mdx  (Getting Started)

The concept page goes above Dashboard, since the dashboard page now
documents the collections list and reads better once a collection has
been defined.

Both URLs change, so both old paths redirect to the new ones. These are
real redirects rather than guesses: `/flaky-tests/get-started/test-collections`
is where the page has lived, and was itself the destination of the
existing `/flaky-tests/test-collections` redirect — which is now the
page's own URL and is therefore dropped.

Link rewriting is the bulk of the diff: 32 files carried absolute links
to one page or the other, five carried relative ones whose meaning
depends on the linking file's directory, and both moved pages needed
their own outbound links reworked — the concept page rose a level, so
every `../` in it became `./`.

The SVG and screenshots stay under `assets/flaky-tests/get-started/`.
Assets do not mirror the navigation here, and their paths are absolute
and unaffected.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Neither page has been publicly live at its old path, so there is nothing
to redirect from. The migration guide was created hidden earlier in this
stack and has never had another URL. The concept page did sit at
`get-started/test-collections`, but `hidden: true` — absent from the
navigation, unlinked, and undiscoverable — and this stack is what
publishes it for the first time.

Every internal link already points at the new paths, and nothing in the
product references either.

That leaves one redirect change against main, a deletion:
`/flaky-tests/test-collections` used to point at the get-started path,
and is now the page's own URL, so keeping it would be config pointing at
a path that no longer exists.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@TylerJang27
TylerJang27 added this pull request to stack #327 September 9, 2026 19:27
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