Repository navigation
docs: make 1.0.0 the only release on the docs site - #413
Merged
Merged
Conversation
Regenerate docs/releases/1.0.0 from 15591e3, whose tutorial credits the 1.0.0 docs, and retire the 0.11.0-rc.1 release from the site. The probe tests keep two releases to tell apart by adding the last 0.11.0-rc.1 server-entry-points page as a fixture prerelease. mintlify.md documents how a release is retired. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
yia-mw-agent
approved these changes
Nov 5, 2026
yia-mw-agent
left a comment
Contributor
There was a problem hiding this comment.
Helmet-Review-Request: #413 (comment)
Reviewed the full merge-base (15591e3, current main) to head diff at aa15f8e. No material defects.
Verified:
- 0.11.0-rc.1 is fully retired: its docs.json entry and docs/releases/0.11.0-rc.1/ are gone, and no page of the 1.0.0 release links into it.
- The 1.0.0 snapshot is regenerated from 15591e3.
docs-release.ts checkreports it consistent, andverify-sourcecompares 20 files with 15591e3 and finds 0 differences. - The probe tests still tell two releases apart: the prerelease is added as a fixture page under scripts/fixtures/docs-probe/, so wrong-release cases still run against real page text.
- The release tests now require one release instead of two, and
SagaAttributionis routed in 1.0.0 only. npm run test:docs: 136 tests pass.docs-release.test.ts: 49 tests pass, anddocs-probe.test.tsandguide.test.tsalso pass.
One note: the first cold run of the generator-reproduction test in docs-release.test.ts hit vitest's 5s default timeout and passed on rerun. This looks like a load flake, not a defect in the PR.
Non-blocking:
- docs/connect/assistants.mdx still says "The site holds more than one release" and mentions prereleases, which is stale now that only 1.0.0 is listed. This is harmless generic guidance and could be tidied later.
- The docs.json hunks that collapse
colorsandseoonto one line are formatting only. - docs/mintlify.md:168 and scripts/docs-probe.ts still name 0.11.0-rc.1 as an example or fixture. This is intentional and consistent with the fixture approach.
This branch was successfully deployed
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.
After this change the docs site lists one release, saga a2ui 1.0.0.
Changes
docs/releases/1.0.0/is regenerated from15591e3. At that revision the tutorial is pinned to the examples game whose credit opens the 1.0.0 tutorial, so no 1.0.0 page links into another release. Only the pinned revision and the tutorial's credit link change; the packages and every other page are the same.docs.jsonentry and itsdocs/releases/0.11.0-rc.1/directory are removed; Git history keeps the snapshot.docs/mintlify.mdgains a "Retire a release" section: remove the entry and the directory in a reviewed PR, after confirming no remaining page links into it.scripts/fixtures/docs-probe/), so every wrong-release case still runs against real page text.SagaAttributionis routed in 1.0.0.docs/connect/assistants.mdx: its examples name only 1.0.0.Checks
npx tsx scripts/docs-release.ts check: "Release documentation is consistent."scripts/docs-release.test.tsandscripts/docs-probe.test.ts: 80 tests pass.npm run test:docs: 136 tests pass.🤖 Generated with Claude Code