Repository navigation
docs: add documentation style check - #6
Merged
Merged
Conversation
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.
Installs the organisation documentation check so the rules in
docs/STYLE_GUIDE.mdare enforced instead of relying on review.scripts/check_style.py— the checker. Phase 1 blocking rules: leakedabsolute paths, broken relative links, missing
AGENTS.md/CLAUDE.md..github/workflows/docs-check.yml— runs the checker on every pull request.AGENTS.md— one sentence under## Local checkspointing at it..gitignore— keeps check output out of the tree.Phase 2 rules (naming, language, content boundaries) stay advisory until the
existing files are cleaned up, so this does not turn current pull requests red.
Where the working tree also carries cleanups, they are part of the same commit:
out/directories removed from the index and archived outside therepository. They carried roughly 100 absolute home paths.
$PROJECTS_ROOT/and<codex-job-root>/.Verified:
python scripts/check_style.py --phase 1reports zero blockingfindings, and
actionlintaccepts the new workflow.