Repository navigation
docs: delete eight obsolete planning docs and point the root docs at the live pages - #26271
Conversation
…the live pages Ruling A on the obsolete-docs decision card. Deleted, history kept in git: docs/NEXT_STEP.md, docs/DX_ROADMAP.md, docs/PLUGIN_ECOSYSTEM_MAP.md, docs/upgrading-to-11.md, docs/v17-docs-sweep.md, docs/launch-readiness.md, docs/plans/m1-project-artifact-schema.md and docs/plans/release-15.1-test-plan.md. - ARCHITECTURE.md becomes a pointer to the published architecture page. - Root CHANGELOG.md keeps its history and gains a top line pointing at content/docs/releases/; its three links to the 11.x upgrade guide now resolve at commit df8aac4. - RELEASE_NOTES.md is marked frozen, loses the "(in progress)" marker and the reference to a changeset file that never existed. - docs/audits/README.md states the open -> closed -> archive/ lifecycle. - Inbound references are rewritten: the published client-sdk page, the platform-checklist README, packages/metadata/ROADMAP.md and PLATFORM_GAPS_FROM_TEMPLATES.md; source comments that cited a deleted file now name the commit that holds it. - check-required-contexts drops docs/launch-readiness.md from its scan set (it hard-fails on a surface it cannot read); check-doc-authoring's example guide name is updated. Claude-Session: https://claude.ai/code/session_01SQ8bET7S4BDrvJdXyuLdYi Co-authored-by: Claude <noreply@anthropic.com>
📓 Docs Drift CheckThis PR changes 3 package(s): 1 hand-written doc(s) NAME something this change touched and may need an implementation-accuracy re-verification:
What this run could not see
Coarse fallback — 24 page(s) merely mention a changed package (the pre-#9192 predicate, kept for the deliberately-wide backstop): Which tree this was computed onThis run read A worktree cut from an older # while this PR is open — GitHub drops the merge commit once it closes
git fetch origin 11d658d36bfea73d067a928216b6af8ee1ed31ff && git checkout 11d658d36bfea73d067a928216b6af8ee1ed31ff
# afterwards, rebuild it from the two parents, which stay fetchable
git fetch origin 9598405ec9aba197a03289890c2eafadec552996 0630f8b1e844de794b16f5bd140f2f199878760b && git checkout -B drift-repro 9598405ec9aba197a03289890c2eafadec552996 && git merge --no-ff 0630f8b1e844de794b16f5bd140f2f199878760b
node scripts/docs-audit/affected-docs.mjs --json 9598405ec9aba197a03289890c2eafadec552996
|
席位核对 · ACCEPT · devx seat 2 · 2026-10-26T18:11ZSeat
Generated by Claude Code |
Requested by Steve · project thread
Fixes #26075
Clause-②: no
Metadata-protocol: none
This is PR 2 of 2 under ruling A (6417413905). PR 1 (#26246, merged) moved the spec-major fingerprint out of
docs/v17-docs-sweep.md. This PR deletes the obsolete planning docs and makes the root docs say only what is true today. History stays in git: every deleted file can still be read at commitdf8aac41.Deleted
docs/NEXT_STEP.md,docs/DX_ROADMAP.md,docs/PLUGIN_ECOSYSTEM_MAP.md,docs/upgrading-to-11.md,docs/v17-docs-sweep.md,docs/launch-readiness.md,docs/plans/m1-project-artifact-schema.md,docs/plans/release-15.1-test-plan.md.Root docs
ARCHITECTURE.mdis now a single paragraph that points to the published architecture page (content/docs/concepts/architecture.mdx, https://objectstack.ai/docs/concepts/architecture). It also links the old long-form text atdf8aac41. Inbound links fromREADME.md,CONTRIBUTING.md,RELEASE_NOTES.md, ADR-0001 anddocs/design/driver-turso.mdstill resolve, so none of those files are touched.CHANGELOG.mdkeeps its history. A new top line points tocontent/docs/releases/and says the file is no longer extended. Its three links todocs/upgrading-to-11.mdnow point to that file atdf8aac41.RELEASE_NOTES.mdis frozen. Its top banner now says "historical and frozen". The never-shipped_(in progress)_marker is removed from the v4.0.4 heading. The pointer to.changeset/v5-project-to-environment-rename.mdis dropped (that file never existed); ADR-0006 stays as the rationale.ARCHITECTURE.mdcarried the same dangling pointer and lost it in the rewrite.docs/audits/README.mdgains the lifecycle rule: an audit is open, then closed, then moved todocs/audits/archive/.Inbound references fixed
content/docs/api/client-sdk.mdx:580no longer sends readers to a repository path. The sentence keeps its fact: the aliases were removed fromclient-reactin v11.docs/qa/platform-checklist/README.md(the predecessor link now goes to the file atdf8aac41; the table row says that the items'§…source citations resolve at that commit),docs/PLATFORM_GAPS_FROM_TEMPLATES.md, andpackages/metadata/ROADMAP.md(not in that package'sfiles).service-automationengine.tsandplugin.tsservice-realtimein-memory-realtime-adapter.tsandrealtime-service-plugin.tsscripts/check-platform-checklist.mjsscripts/check-required-contexts.mjsscripts/check-doc-authoring.mjs: its example guide name changes, and the stale "twelve" count is dropped.packages/spec/scripts/build-docs.ts: the deadDX_ROADMAP.mdpointer is dropped. This is a script, not in the spec package'sfiles.scripts/check-required-contexts.mjsgate input:docs/launch-readiness.mdwas one of itsINSTRUCTION_SURFACES(scan-only,mustName: []). The gate hard-fails on a surface it cannot read, so the row is removed along with the file. Measured: without this change the gate reportsdocs/launch-readiness.md could not be read: the file does not exist.Deliberately left as history (not edited)
docs/adr/0087-metadata-protocol-upgrade-contract.md:65namesdocs/upgrading-to-11.mdin a code span. ADRs are a governed surface.CHANGELOG.mdfiles carry one mention each:cli,core,driver-mongodb,driver-sql,plugin-auth,plugin-security,service-automation,service-job,service-messaging,spec. They are release-owned.docs/qa/platform-checklist/areas/*.json: 20 itemsourcecitations ofrelease-15.1-test-plan.md §…across six area files. They are provenance records. The README row above now tells the reader where they resolve.packages/services/service-realtime/README.md:27says "launch-readiness P0-5". It is a label, not a path, and the README ships in that package's tarball. It is left alone so that this PR publishes nothing.Not in this PR: archiving the 2026-06 audit series (#26257)
The ruling also asked to archive the closed 2026-06 series. Measurement showed that moving it is not docs-only, so the owning seat chose to add only the lifecycle line here and filed the move as #26257. Of the 24
docs/audits/2026-06-*.mdfiles:security-identity-property-liveness,record-search-liveness,metadata-functional-completeness,react-blocks-conformance,react-tier-authoring-dogfoodandhandwritten-docs-accuracy-followups.@objectstack/specpackage. The citations are inliveness/*.json_notefields and in threesrc/**/*.zod.tscomments:field.zod.ts,app.zod.ts, andvalidation.zod.ts, whose TSDoc also generatescontent/docs/references/data/validation.mdx. The 14 files areaction,agent,app,dashboard,field,flow,hook,object,report,skill,tool,view,validationanddead-surface-disposition-plan. Moving them needs a spec patch changeset and regenerated references.docs/audits/:ask-build-agent-development-assessment,datasetschema,pageschemaandsystem-integration.Evidence (head
0630f8b1, base3d50a43b)node scripts/pm/dispatch-gates.mjs --commandson this head derives 113 families. All 113 ran locally and exited 0, with each exit code captured before any pipe. Reconciling with--rangives113 run, 0 NOT-MEASURED. The list includes the families this card names:check:doc-authoring,check:required-contexts,check:doc-anchors,check:published-readme-linksandcheck:pm-dispatch-gates. Four families first stopped at their prerequisite (exit 3):check:skill-examples,check:dual-build-cjs-loadsandcheck:i18nneeded builtdist/trees, and thecheck-plugin-teardown-shapeself-test needed its pinned fixture commit fetched. All four went green once the prerequisite was supplied.pnpm --filter @objectstack/service-automation typecheckandpnpm --filter @objectstack/service-realtime typecheckboth exit 0. Those packages only have comment edits.git grepover the whole repo for every deleted path: the only hits left are commit-anchored references, plus the history listed above.Check Linkslane on this PR is the reading. Its globs arecontent/**,README.mdandARCHITECTURE.md, and none of them still links to a deleted file. The two relative targets this PR adds (content/docs/concepts/architecture.mdxandcontent/docs/releases) both exist.Acceptance notes
skip-changeset. The four package files edited are comment-onlysrc/*.ts.packages/metadata/ROADMAP.mdandpackages/spec/scripts/build-docs.tsare outside their packages'files.mainafter chore(scripts): keep the spec-major fingerprint in its gate, not the v17 sweep ledger #26246 landed. The remote head had been deleted on merge, so this was a plain push and no force-push was needed.Generated by Claude Code