Skip to content

docs: make 1.0.0 the only release on the docs site - #413

Merged
timeleft-- merged 1 commit into
mainfrom
claude/docs-1.0.0-only
Nov 5, 2026
Merged

timeleft-- merged 1 commit into
mainfrom
claude/docs-1.0.0-only

Conversation

@timeleft--

Copy link
Copy Markdown
Member

After this change the docs site lists one release, saga a2ui 1.0.0.

Changes

  • docs/releases/1.0.0/ is regenerated from 15591e3. 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.
  • 0.11.0-rc.1 is retired. Its docs.json entry and its docs/releases/0.11.0-rc.1/ directory are removed; Git history keeps the snapshot.
  • docs/mintlify.md gains a "Retire a release" section: remove the entry and the directory in a reviewed PR, after confirming no remaining page links into it.
  • Probe tests: they still tell two releases apart. They add the last 0.11.0-rc.1 server-entry-points page as a fixture prerelease (scripts/fixtures/docs-probe/), so every wrong-release case still runs against real page text.
  • Release tests: each release needs its own directory and record, without requiring two, and SagaAttribution is 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.ts and scripts/docs-probe.test.ts: 80 tests pass.
  • npm run test:docs: 136 tests pass.

🤖 Generated with Claude Code

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

mintlify Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
saga-a2ui 🟢 Ready View Preview Nov 5, 2026, 7:06 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@yia-mw-agent yia-mw-agent left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 check reports it consistent, and verify-source compares 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 SagaAttribution is routed in 1.0.0 only.
  • npm run test:docs: 136 tests pass. docs-release.test.ts: 49 tests pass, and docs-probe.test.ts and guide.test.ts also 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 colors and seo onto 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.

@timeleft--
timeleft-- merged commit 5097d77 into main Nov 5, 2026
6 checks passed
@timeleft--
timeleft-- deleted the claude/docs-1.0.0-only branch November 5, 2026 19:11

This branch was successfully deployed

1 active deployment
staging — aa15f8e6 Deployed Nov 5, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants