-
Notifications
You must be signed in to change notification settings - Fork 2
docs(10/10): enforce the topics-only tree and remove JS doc shims #752
Copy link
Copy link
Open
Labels
choreMaintenance / refactor / toolingMaintenance / refactor / toolingciContinuous Integration / workflowsContinuous Integration / workflowsdocsDocumentation changesDocumentation changeslegend:DOCSDocumentation truth workDocumentation truth worklegend:PLATFORMPlatform/infrastructure workPlatform/infrastructure worklegend:PROCESSMethod/process workMethod/process worktestsTest suite and coverageTest suite and coveragev0.3.0Scheduled work for the v0.3.0 release.Scheduled work for the v0.3.0 release.work:enablerCreates capability needed for a later product sliceCreates capability needed for a later product slicework:integrityRemoves lies, drift, flake, or trust debtRemoves lies, drift, flake, or trust debt
Description
Metadata
Metadata
Assignees
Labels
choreMaintenance / refactor / toolingMaintenance / refactor / toolingciContinuous Integration / workflowsContinuous Integration / workflowsdocsDocumentation changesDocumentation changeslegend:DOCSDocumentation truth workDocumentation truth worklegend:PLATFORMPlatform/infrastructure workPlatform/infrastructure worklegend:PROCESSMethod/process workMethod/process worktestsTest suite and coverageTest suite and coveragev0.3.0Scheduled work for the v0.3.0 release.Scheduled work for the v0.3.0 release.work:enablerCreates capability needed for a later product sliceCreates capability needed for a later product slicework:integrityRemoves lies, drift, flake, or trust debtRemoves lies, drift, flake, or trust debt
Decision
Finish the reconstruction with one canonical documentation topology and one Rust-native truth gate. Transitional JavaScript parity checks and dead workspace/documentation scripts are removed only after native coverage proves equivalence or stronger behavior.
This is documentation reconstruction slice 10 of 10.
Scope
docs/truth-manifest.jsonan exact, deterministic map of the public rootREADME.mdplus trackeddocs/topics/**/*.md.docs/must live underdocs/topics/. Permit only explicitly required machine metadata/assets outside it.cargo xtask docs-checkthe sole implementation for link targets and anchors, native command/flag truth, pnpm package/script truth, current path claims, release-language truth, manifest coverage, and topics-only topology.scripts/check-doc-links.mjsscripts/check-doc-truth.mjsscripts/check-doc-cli-commands.mjstasks:updatescript andscripts/tasks-update.mjsKeep live JavaScript with an explicit owner—especially
packages/wesley-holmesand necessary repository automation. This is removal of dead docs-era duplication, not a blanket language purge.RED
Add final fixtures that fail on: any non-topic Markdown under
docs/, an unmanifested topic, a manifest entry without a topic, an audit sidecar, a missing anchor, a stale command/flag, a zero-match pnpm filter, and a deleted JS-check reference.Acceptance
docs/outsidedocs/topics/.*.audit.mdsidecar, duplicate docs shell, historical attic, or JavaScript docs checker remains.cargo test --locked -p xtask, all relevant Bats suites,cargo xtask docs-check, fullpnpm run preflight, andgit diff --checkpass.Scheduling
v0.3.0label is temporary until the plain version-milestone cutover.