Install any skill in seconds. Free to start, no credit card required.
Get Started Free →yurunchen/repo-docs
Build and maintain a Markdown guide that helps humans understand a repository through real behavior, concepts, and evidence.
Passed 14 of 18 test cases with the skill, and 4 of 18 without it.
and 12 more in the full report
13 fixed4 passed either way4 still failing1 broke
Tokens, turns and time describe resource use, not a dollar price.
One of 13 test cases the skill fixed. Same model, same prompt, with and without the skill.
At the bottom of narrative documentation pages like modules/authentication.md, what standard footer line should be placed to state source evidence confidence?
| Checked | Without skill | With skill |
|---|---|---|
| Includes the explicit footer string Evidence status: Confirmed unless noted. | Missed | Passed |
The instructions your model reads when the skill loads.
repo-docs explains a repository to a human reader.
Do not start with a tree tour. Build a reader model first: what problem the repo solves, one real behavior it performs, the concepts behind that behavior, where those responsibilities live in code, where source truth lives, and how to verify the understanding.
Keep the routing narrow. SKILL.md defines the contract; topic files carry the detailed rules. If a detail appears in two places, keep it in the topic file and leave a pointer here.
| File | Role |
|---|---|
SKILL.md | Entry: mission, core laws, output contract, mode router, finish gate |
REFERENCE.md | Router to topic files; open only when detail is needed |
WRITING.md | Explanation design, voice, evidence discovery |
PAGE_RULES.md | Build workflow, reader paths, page types, output shape, navigation |
SCOPE_MODES.md | Seed, large/monorepo scope, specialized repos |
SYNC_RULES.md | Sync decision gate, question loop, change sync, widened content alignment |
ROOT_AGENT_RULES.md | Root AGENTS.md / CLAUDE.md routing block and install contract |
QUALITY_RULES.md | Evidence labels, source truth, quality bar |
EXAMPLES.md | Finished-page tone and output-shape examples |
scripts/validate_repo_docs.py | Structure, links, sync anchors, freshness, evidence, references scope, and quality-review checks |
validate_repo_docs.py | Compatibility wrapper for older invocations |
evals/ | Source-repository regression fixtures and assertions for this skill; not required at runtime |
../repo-docs-zh/SKILL.md | Chinese language overlay |
test cases passed, vs 4 / 18 without
More skills from the same source and nearby in the registry, with their headline benchmark lift.