Skip to content

docs: add documentation style check - #6

Merged
Pigbibi merged 1 commit into
mainfrom
chore/docs-check
Oct 28, 2026
Merged

Pigbibi merged 1 commit into
mainfrom
chore/docs-check

Conversation

@Pigbibi

@Pigbibi Pigbibi commented Oct 28, 2026

Copy link
Copy Markdown
Contributor

Installs the organisation documentation check so the rules in
docs/STYLE_GUIDE.md are enforced instead of relying on review.

  • scripts/check_style.py — the checker. Phase 1 blocking rules: leaked
    absolute 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 checks pointing 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:

  • Committed out/ directories removed from the index and archived outside the
    repository. They carried roughly 100 absolute home paths.
  • Absolute home paths in research documents replaced with $PROJECTS_ROOT/ and
    <codex-job-root>/.
  • Broken relative links repaired after earlier renames.

Verified: python scripts/check_style.py --phase 1 reports zero blocking
findings, and actionlint accepts the new workflow.

@Pigbibi
Pigbibi merged commit 3d3c9b9 into main Oct 28, 2026
1 check passed
@Pigbibi
Pigbibi deleted the chore/docs-check branch October 28, 2026 18:03
This was referenced Nov 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant