feat(tools): add documentation audit CLI tool#576
Merged
Conversation
Add Python CLI tool (tools/doc-audit/) with 4 checkers for validating documentation quality across the kcenon ecosystem: - checker_metadata: YAML frontmatter validation (required fields, doc_id format, semver, ISO 8601 dates, status enum, duplicates) - checker_links: Internal markdown link and anchor validation with code block skip to avoid false positives from C++ lambdas - checker_ssot: SSOT registry consistency (file existence, doc_id match, unlisted file detection) - checker_structure: README.md standard section compliance (13 sections) CLI supports --quick (metadata+structure only), --format (markdown/json/both), and --ecosystem (audit all 8 projects) flags. Exit code 1 on critical findings. Closes #567
kcenon
added a commit
that referenced
this pull request
Apr 13, 2026
Add Python CLI tool (tools/doc-audit/) with 4 checkers for validating documentation quality across the kcenon ecosystem: - checker_metadata: YAML frontmatter validation (required fields, doc_id format, semver, ISO 8601 dates, status enum, duplicates) - checker_links: Internal markdown link and anchor validation with code block skip to avoid false positives from C++ lambdas - checker_ssot: SSOT registry consistency (file existence, doc_id match, unlisted file detection) - checker_structure: README.md standard section compliance (13 sections) CLI supports --quick (metadata+structure only), --format (markdown/json/both), and --ecosystem (audit all 8 projects) flags. Exit code 1 on critical findings. Closes #567
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
tools/doc-audit/) with 4 modular checkers: metadata validation, internal link checking, SSOT registry consistency, and README structure compliance--quickmode for CI (metadata + structure only),--ecosystemmode for all 8 projects, and--formatflag for markdown/json/both outputPREFIX-CAT-NNN), broken internal links (with code block skip), SSOT registry table parsing, and 13 standard README sectionsTool Structure
Usage
Test plan
--quickmode on common_system (7 findings detected correctly)--ecosystemmode across all 8 repos (54 findings in quick mode)--format jsonoutput (valid JSON, correct finding counts)Closes #567