docs: audit links, glossary T0-T4, readability pass
CI & Release / Verify simulator (push) Skipped
CI & Release / Trivy scan (push) Skipped
CI & Release / Semantic Release (push) Skipped
CI & Release / Verify simulator (pull_request) Failing after 4s
CI & Release / Trivy scan (pull_request) Skipped
CI & Release / Semantic Release (pull_request) Skipped
CI & Release / Verify simulator (push) Skipped
CI & Release / Trivy scan (push) Skipped
CI & Release / Semantic Release (push) Skipped
CI & Release / Verify simulator (pull_request) Failing after 4s
CI & Release / Trivy scan (pull_request) Skipped
CI & Release / Semantic Release (pull_request) Skipped
Extend glossary with storage floors, source of truth, and linkable anchors. Fix broken links, pose frame drift, rsync/offload wording, and README tone. Add docs/improvement audit records and live demo links in design journey.
This commit is contained in:
@@ -0,0 +1,18 @@
|
||||
# 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-audit.md) | 2026-07-10 | Full `docs/` + README pass; glossary T0–T4; live demo links |
|
||||
|
||||
## Future automation
|
||||
|
||||
Tracked in [issue #1](https://git.produktor.io/eSlider/swarm-house/issues/1): CI link checker, glossary anchor validation, terminology lint.
|
||||
|
||||
## 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](../09-open-questions.md) if new ambiguities appear.
|
||||
Reference in New Issue
Block a user