eSlider/swarm-house
1
0
Fork 0
Code Issues 2 Pull Requests 3 Actions Packages Projects 1 Releases 13 Wiki Activity

feat: add CI documentation rules checker and docs-verify job
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
Details
CI & Release / Verify simulator (pull_request) Failing after 9s
Details
CI & Release / Trivy scan (pull_request) Skipped
Details
CI & Release / Semantic Release (pull_request) Skipped
Details

Browse Source 
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.
This commit is contained in:
eSlider
2026-07-10 10:54:28 +01:00
parent 9bec50e8f7
commit e6e57843cb
8 changed files with 422 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/improvement/2026-07-10-audit.md
+2 -6
View File
@@ -16,7 +16,7 @@ Manual pass over `docs/`, all READMEs, and glossary. Goal: correct links, unify
### Links
- `infra/terraform/ground/README.md` pointed at non-existent `03-storage-design.md` → `03-data-platform.md`.
- `11-cicd-delivery.md` bare `see 05` → proper markdown link.
- `11-cicd-delivery.md` bare cross-reference to doc 05 → proper markdown link.
### Factual drift (code vs docs)
@@ -63,11 +63,7 @@ Manual pass over `docs/`, all READMEs, and glossary. Goal: correct links, unify
## Suggested CI checks (for issue #1)
```bash
# Relative .md link resolver (Python one-liner in audit script)
# Glossary anchor: every 00-glossary.md#... from docs/ must resolve
# Optional: markdown-spellcheck with US locale
```
Implemented in [`scripts/check_docs.py`](../../scripts/check_docs.py) — see [ci-rules.md](ci-rules.md).
## Files touched