Skip to content

docs(8/10): consolidate validation CI security and invariants #750

Description

@flyingrobots

Decision

Give operators one truthful route for local validation, CI, security tooling, repository invariants, and generated-artifact hygiene.

This is documentation reconstruction slice 8 of 10.

Scope

Rewrite current, executable guidance into:

  • docs/topics/validation.md
  • docs/topics/ci-workflows.md
  • docs/topics/security-tooling.md
  • docs/topics/invariants.md
  • docs/topics/artifacts-and-cache.md
  • docs/topics/docs-maintenance.md

Extract verified rules from and then delete duplicate reader-facing material under:

  • docs/invariants/
  • docs/ci.md
  • docs/scripts-reference.md
  • standalone security/tooling pages outside the topic tree
  • obsolete audit summaries that are incorrectly used as current operational guidance

Every documented command must be runnable and every named check must match actual cargo xtask, package, Bats, or workflow behavior. Describe retained JavaScript automation only where it has a real current owner; do not call deleted packages “core,” “CLI,” or “generators.”

Update hard-coded documentation paths in affected workflows and Bats suites in the same slice.

RED

Add focused fixtures for the known false-green classes: nonexistent pnpm filters that exit zero, undocumented/misnamed xtask checks, stale workflow names, missing paths, and invalid anchors.

Acceptance

  • Operators have one local-check matrix and one CI interpretation route.
  • Invariant pages state enforced properties and point to the enforcing code/test, not historical intent.
  • No command succeeds merely because pnpm matched zero packages.
  • Duplicate source pages are deleted rather than archived.
  • Relevant workflow tests, Bats suites, docs-check, preflight, and git diff --check pass.

Scheduling

Metadata

Metadata

Assignees

No one assigned

    Labels

    choreMaintenance / refactor / toolingciContinuous Integration / workflowsdocsDocumentation changeslegend:DOCSDocumentation truth worklegend:PLATFORMPlatform/infrastructure worklegend:PROCESSMethod/process worklegend:RUNTIMERuntime/tooling/host/operator flow worktestsTest suite and coveragev0.3.0Scheduled work for the v0.3.0 release.work:integrityRemoves lies, drift, flake, or trust debt

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions