bea1903ac9
Some checks failed
Deploy to Phoenix / deploy (push) Has been cancelled
Co-authored-by: Cursor <cursoragent@cursor.com>
1.9 KiB
1.9 KiB
Documentation Metrics
Last Updated: 2026-01-31
Document Version: 1.0
Status: Active Documentation
Overview
Simple metrics to track documentation health. Update periodically (e.g. monthly or after major doc changes).
Metrics Table
| Metric | Target | Last Check | Notes |
|---|---|---|---|
| Broken link count (docs/ and root) | 0 | See reports/BROKEN_REFERENCES_REPORT.md | Prioritize docs/ and root; submodules separate |
| Docs with standard header | All active docs | Run docs/scripts/validate-doc-headers.sh |
Last Updated, Status, --- |
| MASTER_INDEX / docs/README in sync | Yes | 2026-01-31 | Directory tree, dates, category links |
| Last full documentation review | Quarterly | 2026-01-31 | COMPREHENSIVE_DOCUMENTATION_REVIEW, DOCUMENTATION_FIX_TASK_LIST |
| Link validation run | Monthly | — | markdown-link-check or lychee from docs/ |
| Number of active docs (01–12) | — | 48+ key docs | MASTER_INDEX counts |
How to Update
- Broken links: Run link checker; fix docs-internal and root; update "Last Check" above or this file's date.
- Headers: Run
docs/scripts/validate-doc-headers.sh; fix failures; re-run until clean (or document exceptions). - Review: After quarterly review, set "Last full documentation review" to current date.
- Link validation run: After running markdown-link-check/lychee, note date here.
Related Documentation
- DOCUMENTATION_FIX_TASK_LIST.md - All fix tasks
- DOCUMENTATION_STYLE_GUIDE.md - Review schedule, validation
- COMPREHENSIVE_DOCUMENTATION_REVIEW_2026-01-31.md - Full review
- ../../reports/BROKEN_REFERENCES_REPORT.md - Broken refs (repo root reports/)