doc-check
Skill4 starsChanged 3 months agoMITView on GitHub
Run or choose repository-local formatting, linting, and consistency checks for markdown, text, and documentation files before committing. Use when documentation files changed, standards docs were edited, or the user asks to verify docs formatting.
4 other projects use a version of this.
Adopted by
Most recently taken up by
- lelborn/skillstheir own version, first seen Nov 1, 2026
- coder/codertheir own version, first seen Oct 8, 2026
- ba0918/claude-skillstheir own version, first seen Jul 9, 2026
- bmarshall511/forexflowtheir own version, first seen Apr 17, 2026
Other versions4 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 4
- coder/coder★ 17ksame name
- bmarshall511/forexflow★ 14same name
- ba0918/claude-skills★ 0same name
- lelborn/skills★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository21 other files it gives its agents.
- templates/AGENTS.mdAGENTS.md
- architecture-doc-builderSkill
- confluenceSkill
- conformanceSkill
- feature-doc-builderSkill
- gh-issueSkill
- gh-stackSkill
- gh-wikiSkill
- handoffSkill
- jiraSkill
- pr-builderSkill
- proposal-builderSkill
- pr-reviewSkill
- psqlSkill
- qa-testingSkill
- spec-builderSkill
- spec-drivenSkill
- sqlcmdSkill
- standard-builderSkill
- worktreeSkill
- zazz-boardSkill
The file
We split this skill into the rules it gives an agent
8 rules. 0 are common, 6 are distinctive, and 2 are very specific to this project.
0
Common
Most of the 3 edited versions we read keep these.
6
Distinctive
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 8
Run documentation checks using the repository's own tooling.
- Very specific: line 13
Read repo instructions (AGENTS.md, README, contributing docs) and hook configuration files such as .pre-commit-config.yaml, package.json, …
- Very specific: line 14
Prefer the narrowest repo-declared command that checks the changed docs.
- Distinctive: line 16
If a formatter modifies files, rerun the same check once to verify stability.
- Distinctive: line 21
Do not run all-docs or all-files checks by default when a file-scoped command exists.
- Distinctive: line 22
Do not touch unrelated formatting churn.
- Distinctive: line 23
If the repo uses a virtual-branch or stacked-diff tool, identify which changed files belong to the current unit of work before running …
- Distinctive: line 24
If no doc tooling exists, perform a manual pass for broken links, stale paths, private local paths, merge markers, trailing whitespace, and …
“Common” is measured: kept by at least 6 in 10 of the 3 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Document Check
Run documentation checks using the repository's own tooling. Do not install or invent formatters when the repo already declares hooks, package scripts, make targets, or CI jobs.
Workflow
- Identify changed documentation files with
git status --shortand, when needed,git diff --name-only. - Read repo instructions (
AGENTS.md, README, contributing docs) and hook configuration files such as.pre-commit-config.yaml,package.json,pyproject.toml,justfile,Makefile, or markdownlint config. - Prefer the narrowest repo-declared command that checks the changed docs. Common examples include
pre-commit run --files ...,prek run --files ...,npm run lint:docs,markdownlint,mdformat, or a repo-specificjusttarget. - Include all text-like files affected by the change, not only
.md, when hooks apply to trailing whitespace, final newline, merge conflict markers, YAML, TOML, or generated docs. - If a formatter modifies files, rerun the same check once to verify stability.
- Report commands, results, and any files changed by formatting.
Boundaries
- Do not run all-docs or all-files checks by default when a file-scoped command exists.
- Do not touch unrelated formatting churn.
- If the repo uses a virtual-branch or stacked-diff tool, identify which changed files belong to the current unit of work before running broad fixers.
- If no doc tooling exists, perform a manual pass for broken links, stale paths, private local paths, merge markers, trailing whitespace, and missing final newline.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

