Files
swarm-house/docs/improvement
eSlider bed6f93626
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
docs: default caveman style for issues, PRs, and reviews
Document caveman-full as the collaboration voice in AGENTS and CONTRIBUTING,
and add Gitea issue/PR templates that pre-fill terse structure.
2026-07-10 10:56:13 +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

Collaboration style

Issues, PRs, and reviews default to caveman-full (CONTRIBUTING.md, AGENTS.md). Gitea templates live under .github/ISSUE_TEMPLATE/ and .github/pull_request_template.md.

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.