Files
swarm-house/docs/improvement
eSlider e6e57843cb
CI & Release / Verify documentation (push) Skipped
CI & Release / Verify simulator (push) Skipped
CI & Release / Trivy scan (push) Skipped
CI & Release / Semantic Release (push) Skipped
CI & Release / Verify documentation (pull_request) Successful in 5s
CI & Release / Verify simulator (pull_request) Failing after 9s
CI & Release / Trivy scan (pull_request) Skipped
CI & Release / Semantic Release (pull_request) Skipped
feat: add CI documentation rules checker and docs-verify job
Enforce link resolution, glossary anchors, and readability rules on every
push and PR; docs-only pushes to main still run docs-verify while skipping
the simulator gate.
2026-07-10 10:54:28 +01:00
..

Documentation improvement records

Point-in-time audits and follow-up work for links, terminology, readability, and factual alignment with code.

Report Date Scope
2026-07-10 audit 2026-07-10 Full docs/ + README pass; glossary T0T4; live demo links

CI automation

Enforced in Gitea Actions (docs-verify job). Rules live in scripts/docs_rules.yaml; see ci-rules.md.

Originally tracked in issue #1.

How to add a new report

  1. Copy the structure from the latest audit file.
  2. Name it YYYY-MM-DD-short-topic.md.
  3. Add a row to the table above.
  4. Cross-link from 09 — Open questions if new ambiguities appear.