feat: documentation quality rubric + validate-docs companion reference#17
Merged
Conversation
…rence - New builtin rubric: documentation.json (12 criteria, 6 categories) Covers claim discipline, consistency, boundary, accuracy, navigation, quality - Cross-reference between validate-docs.py and documentation rubric Mechanical checks (validate-docs) complement semantic evaluation (rubric) - Rubric includes companion_tools metadata linking the two together
Contributor
Author
CI Triage — Quorum Self-ValidationVerdict: REVISE (10 findings on All findings are pre-existing — this PR only adds 7 lines of docstring text. The file itself was not functionally changed. 2 HIGH — False PositivesBoth flag
Both call sites (lines 359 and 411) already have 6 MEDIUM + 2 LOW — Pre-existing Design DebtPC-005, PC-006, PC-007, PC-008, PC-025 (SRP, god function, duplication, hardcoded deps, mixed I/O), PC-012 (input validation), PC-017 (magic numbers), PC-009 (resource lifecycle). All pre-existing, same findings surfaced on PR #14 CI run. Routed to stale content backlog. |
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
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.
What
documentation.json(12 criteria across 6 categories: claim_discipline, consistency, boundary, accuracy, navigation, quality)validate-docs.pyand the documentation rubric viacompanion_toolsmetadataWhy
PR #16 validation revealed no documentation rubric existed. The research-synthesis rubric produced >50% NOT_APPLICABLE on markdown docs. This rubric was designed specifically for project documentation: READMEs, specs, changelogs, tutorials, and guides.
Files Changed
reference-implementation/quorum/rubrics/builtin/documentation.json(new)tools/validate-docs.py(companion docstring added)Criteria Summary
DOC-005 and DOC-008 are marked
deterministic: truefor Tester L1 (zero API cost).Validation
validate-docs.py: clean ✅