Skip to content

docs(10/10): enforce the topics-only tree and remove JS doc shims #752

Description

@flyingrobots

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

  • Make docs/truth-manifest.json an exact, deterministic map of the public root README.md plus tracked docs/topics/**/*.md.
  • Add a topology invariant: reader-facing Markdown inside docs/ must live under docs/topics/. Permit only explicitly required machine metadata/assets outside it.
  • Remove every temporary migration allowlist.
  • Make cargo xtask docs-check the 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.
  • Replace the JavaScript docs workflow with the Rust-native gate, then delete duplicate/dead shims such as:
    • scripts/check-doc-links.mjs
    • scripts/check-doc-truth.mjs
    • scripts/check-doc-cli-commands.mjs
    • their dedicated parity tests and preflight hooks
    • the broken tasks:update script and scripts/tasks-update.mjs
    • stale pnpm workspace entries that match no package
  • Update root entrances, CI path filters, package scripts, contributor guidance, release guards, and topic navigation to the final paths.

Keep live JavaScript with an explicit owner—especially packages/wesley-holmes and 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

  • The root product entrance and topic tree provide complete current navigation.
  • No reader-facing Markdown remains under docs/ outside docs/topics/.
  • No *.audit.md sidecar, duplicate docs shell, historical attic, or JavaScript docs checker remains.
  • The truth manifest and tracked topic Markdown are bijective.
  • Pages/navigation, docs workflow, cargo test --locked -p xtask, all relevant Bats suites, cargo xtask docs-check, full pnpm run preflight, and git diff --check pass.
  • A final repository search finds no references to deleted paths or scripts.
  • The campaign closes only when all ten issues are green and the final PR has no unresolved review threads.

Scheduling

Metadata

Metadata

Assignees

No one assigned

    Labels

    choreMaintenance / refactor / toolingciContinuous Integration / workflowsdocsDocumentation changeslegend:DOCSDocumentation truth worklegend:PLATFORMPlatform/infrastructure worklegend:PROCESSMethod/process worktestsTest suite and coveragev0.3.0Scheduled work for the v0.3.0 release.work:enablerCreates capability needed for a later product slicework:integrityRemoves lies, drift, flake, or trust debt

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions