Repository navigation
docs-lint: rule f checks the ADR shape the umbrella requires - #125
Merged
Merged
Conversation
The umbrella's docs build fails on an ADR whose file name is not NNNN-<slug>.md, whose H1 is not "# ADR-NNNN: <decision>", or that has no "| **Status** |" row, and on a hand-written adr/index.md or README.md. No repo checked this before merging; marola-ml merged "# ADR 0001:" headings and the build broke. docs-lint now reports the same checks, with the umbrella's patterns and wording, so every repo's gate catches it. Closes #124 Tested: python3 scripts/docs_lint.py --self-test ok (red first); docs-lint on marola-ml b48d669 gives 3 (f) findings, on add187c and marola-app main clean; devkit-quality.sh == quality rc=0 Co-Authored-By: Claude <[email protected]>
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.
The umbrella's docs build fails on an ADR whose file name is not NNNN-.md, whose
H1 is not "# ADR-NNNN: ", or that has no "| Status |" row, and on a
hand-written adr/index.md or README.md. No repo checked this before merging; marola-ml
merged "# ADR 0001:" headings and the build broke. docs-lint now reports the same
checks, with the umbrella's patterns and wording, so every repo's gate catches it.
Closes #124
Tested: python3 scripts/docs_lint.py --self-test ok (red first); docs-lint on marola-ml b48d669 gives 3 (f) findings, on add187c and marola-app main clean; devkit-quality.sh == quality rc=0
Co-Authored-By: Claude [email protected]