Repository navigation
Remove migrations page from docs site - #967
Merged
Merged
Conversation
`docs/migrations.md` inlined the frozen root `MIGRATIONS.md`, which by design holds only pre-fragment history: every migration written under the per-package `migrations.d/` convention was missing from the published page. An upgrade guide that silently omits the current migrations is worse than no page, because it reads as authoritative. Remove the page, its sidebar entry, and the `MIGRATIONS.md` path from the publisher's trigger (#882 already dropped it from the PR-side build). The alternative -- aggregating `packages/*/migrations.d/*.md` at build time -- is recorded in agents/reference/changelog-migrations.md as the option not taken; it needs a build step and a fragment ordering convention. Cross-references that pointed at the page (README, the root and per-package `MIGRATIONS.md` pointer stubs, docs/AGENTS.md) now point at the fragment dirs instead, so nothing links to a 404. Fixes #885 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014Wb5FG2GSbcfUMothCFZej
This was referenced Aug 20, 2026
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.
The
/migrationspage on the docs site is being removed because it only surfaced pre-fragment migration history via a VitePress include. Since the project now uses per-package migration fragments (one file per breaking change underpackages/*/migrations.d/), a page built from the frozen rootMIGRATIONS.mdwould silently omit all current migrations and present an incomplete, misleading upgrade guide.Fixes #885
Changes:
docs/migrations.md(the VitePress include wrapper)docs/.vitepress/config.ts)MIGRATIONS.md(not published)migrations.d/directoryAGENTS.mdunder "Changelog and Migrations"MIGRATIONS.mdand packageMIGRATIONS.mdfiles to remove references to the now-removed/migrationspageREADME.mdto point users to the per-package migration fragments instead of a single docs pageMIGRATIONS.mdfrom the docs release workflow trigger (no longer published)agents/reference/changelog-migrations.mdto explain why the frozen file is not publishedThis aligns the docs site with the actual migration workflow where contributors add fragments to their package's
migrations.d/directory rather than editing a central file.The alternative considered — aggregating
packages/*/migrations.d/*.mdinto the page at build time — is recorded inagents/reference/changelog-migrations.mdas the option not taken: it needs a build step and a fragment ordering convention.Every file touched beyond
docs/linked to the page being deleted; without those edits the change would leave dead links inREADME.md, all fourMIGRATIONS.mdpointer stubs, and two agent docs. Editing the frozenMIGRATIONS.mdfiles here removes a dead pointer rather than appending an entry, so it does not cross the freeze rule.Manual verification
pnpm buildindocs/— clean. VitePress fails the build on dead links, so this is what proves the sidebar entry removal is complete. The builtdist/contains nomigrations.htmland zero occurrences of "migrations".npx vitepress preview --port 5199.curl -o /dev/null -w '%{http_code}' http://127.0.0.1:5199/dirsql/migrations→404/dirsql/reference/sdk.htmllists every other reference page (CLI, Configuration File, Command Hooks, Columns, Path-tables, HTTP API, SDK) and no Migrations entry.e2e verifyrun locally with CI-equivalent scoping for both bindings → exit 0, so the committed attestations stay fresh (nothing underpackages/*/srcchanged):uvx testing-conventions e2e verify --base ddb7208 --scope packages/python/dirsql --extra-scope packages/rust/src packages/pythonchangelog-gaterun locally over this diff → exit 0.E2E Verification
N/A - docs/lint/typo onlyChangelog / Migrations
packages/<pkg>/changelog.d/for each changed package (or:skip-changelogtrailer on a commit with reason) — not required: the only files touched underpackages/are theMIGRATIONS.mdpointer stubs, whichchangelog_gate's_is_exemptexcludes fromcode_touched. Verified by running the gate locally over this diff (exit 0).packages/<pkg>/migrations.d/(or: not required — additive/bugfix only) — not required: no public API, config key, CLI flag, or runtime behavior changes.PARITY.mdis unchanged: no SDK public API surface is touched.🤖 Generated with Claude Code
https://claude.ai/code/session_014Wb5FG2GSbcfUMothCFZej