eSlider
826cef0c3e
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 4s
CI & Release / Verify simulator (pull_request) Successful in 11s
CI & Release / Trivy scan (pull_request) Successful in 8s
CI & Release / Semantic Release (pull_request) Skipped
Store doc rules in bin/docs_rules.json (stdlib json). test_check_docs no longer fails in the simulator job that only installs simulator/requirements.txt.
1.2 KiB
1.2 KiB
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 T0–T4; 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 bin/docs_rules.json; see ci-rules.md.
Originally tracked in issue #1.
How to add a new report
- Copy the structure from the latest audit file.
- Name it
YYYY-MM-DD-short-topic.md. - Add a row to the table above.
- Cross-link from 09 — Open questions if new ambiguities appear.