DOCUMENTATION CHECKS
Documentation Guard
Checks Markdown length and adds actionable annotations to failed GitHub Actions runs: 2,000 words for README.md, 4,000 for other .md and .mdx files.
For maintainers: Add one step to CI. No secrets or extra configuration are needed.
Maintainer setup
Add this step to an existing GitHub Actions job:
- name: Check documentation length
uses: zc6600/agentic-swe@main
Instructions for coding agents
Copy these instructions into your coding agent.
Integrate Documentation Guard into this repository.
1. Inspect the existing GitHub Actions workflows and add the step below to the relevant CI job.
2. Do not add secrets; this action requires none.
3. Validate the workflow and report the file changed.
- name: Check documentation length
uses: zc6600/agentic-swe@main
The action checks README.md against a 2,000-word limit and other .md/.mdx files against a 4,000-word limit. It reports actionable GitHub annotations when a limit is exceeded.
Pin the action to a reviewed release or commit SHA for production.