chore: docs/ prose-only gate (Makefile target + CI step)#5
Merged
Conversation
Adds make check-docs-prose as a cross-repo guardrail: docs/ holds only human-readable prose (.md, .markdown, images, .gitkeep). Non-prose artifacts — generated data, JSON/TSV output, copy-paste examples, scaffolding templates — belong under dist/, examples/, templates/, or a top-level domain-specific directory. Wires into CI alongside the existing engine-free drift gates (manifest-check / skill-check / doctest-check). Engine-free, fast, find-based. Currently green (m-stdlib's docs/ is already prose-only — this is preventive, not corrective).
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
Adds
make check-docs-proseas a cross-repo guardrail:docs/holds only human-readable prose (.md,.markdown, images,.gitkeep). Non-prose artifacts — generated data, JSON/TSV output, copy-paste examples, scaffolding templates — belong underdist/,examples/,templates/, or a top-level domain-specific directory.Why
After the Phase 0 cross-repo cleanup (m-standard PR #6, m-cli PR #9, m-stdlib PR #4) it became clear the recurrence risk is at the human-curation layer — no Python tool wrote to
docs/; the violations were one-time commits. A simple find-based gate prevents future regressions without depending on agent attention.Same target lands in all four repos so any future contributor (or future automation) gets a consistent fail-fast signal.
Wiring
check-docs-prosetarget; added to.PHONYlist.m-stdlibjob, sitting alongside the existing engine-free drift gates (manifest-check / skill-check / doctest-check). Engine-free, ~50ms find.Test plan
make check-docs-prosegreen locally (m-stdlib'sdocs/is already prose-only)