Merge pull request 'chore(scripts): promote index-coverage checker; document bundle gates' (#31) from chore/29-kb-coverage-tooling into main

This commit was merged in pull request #31.
This commit is contained in:
2026-10-19 10:01:30 -07:00
2 changed files with 22 additions and 1 deletions
+22 -1
View File
@@ -8,7 +8,7 @@ tags:
- documentation - documentation
- best-practices - best-practices
- unverified - unverified
timestamp: 2026-01-15 timestamp: 2026-10-19
--- ---
# OKF Bundle Maintenance # OKF Bundle Maintenance
@@ -139,6 +139,27 @@ git status --short # What is uncommitted
| `index.md` count differs from file count | Always | Fix immediately | | `index.md` count differs from file count | Always | Fix immediately |
| `log.md` has no entries for 30+ days | Context-dependent | Normal if no changes made | | `log.md` has no entries for 30+ days | Context-dependent | Normal if no changes made |
---
## Automated Gates (this bundle)
Two mechanical checkers live in `scripts/`; both exit non-zero on violations.
Run both before committing any `omp-docs/` change; `tests/kb-lint.bats` pins
their behavior.
```bash
bash scripts/kb-lint.sh omp-docs # OKF conformance
python3 scripts/kb-coverage.py omp-docs # index coverage doctrine
```
- **kb-lint** — OKF v0.1 rules: non-empty `type` frontmatter on every
non-index file, no frontmatter on `index.md`, resolvable wikilinks and
relative links, reserved names (`index.md`/`log.md`), `YYYY-MM-DD` log
headings.
- **kb-coverage** — the AGENTS.md anti-rot mechanism: every directory has an
`index.md`, and that index links every sibling file and subdirectory.
--- ---
## See Also ## See Also