26 lines
1.1 KiB
Markdown
26 lines
1.1 KiB
Markdown
---
|
|
name: docs-lint
|
|
risk_class: read_only
|
|
inputs: [paths]
|
|
verification: "python3 .agents/skills/docs-lint/lint.py"
|
|
docs_update_checklist: []
|
|
---
|
|
|
|
# Docs lint
|
|
|
|
Check committed documentation against the mechanical rules in
|
|
[writing-style.md](../../shared/writing-style.md): banned vocabulary and broken relative markdown
|
|
links. Prose-voice rules are not machine-checkable — those stay a review responsibility.
|
|
|
|
Run from the repo root:
|
|
|
|
python3 .agents/skills/docs-lint/lint.py # default: knowledge/ .agents/ operations/ investigations/ plans/
|
|
python3 .agents/skills/docs-lint/lint.py archive/knowledge/containers/104-gitea.md
|
|
|
|
Exit code is non-zero when any violation is found, so it can gate a commit. The banned-vocabulary
|
|
list mirrors `writing-style.md`; update both together if the standard changes.
|
|
|
|
> **Known baseline.** `archive/knowledge/containers/101-jellyfin.md` links into a sibling repo
|
|
> (`devops/homelab-authentik-admin`) that this checkout does not contain — expected, not a bug.
|
|
> Any other broken link is a real regression; investigate before dismissing it as baseline noise.
|