repo-docs — Repository Guide Builder & Sync

Builds a behavior-first Markdown guide to any repository and keeps it in sync as the code changes.

Dev & CodingIntermediate★ 467⑂ 6AI score 10/10Last updated: Jul 12, 2026

What it does

Generates a documentation package that teaches a repo through one real behavior (a request, task, failure, or data path) before any file-tree tour.
Produces a fixed, ownership-based layout: README.md, walkthroughs/one-real-run.md, code-map.md, modules/, references/source-evidence.md, glossary.md, change-log.md.
Picks a package size for the repo: Standard, Lite, or Seed (for projects with no real implementation yet).
Uses a sync decision gate so ordinary repo questions do not silently rewrite docs: none, answer-only, foreground patch, or background sync.
Requires evidence (source, tests, config, commands) behind every durable claim, recorded in a Claim | Evidence | Confidence | Caveat | Used by table.
Runs scripts/validate_repo_docs.py to check structure, links, freshness, evidence, and references scope before delivery.
Wires a short Repo docs routing block into the root AGENTS.md / CLAUDE.md.

Who it's for

Developers and tech leads producing onboarding material for a codebase.
Maintainers whose docs drift out of date after every release.
Anyone inheriting a legacy or unfamiliar repository who needs a reader model fast.
Monorepo teams who need a scoped guide that states what is not covered.

Examples

"Generate repo-docs for this project" → picks a representative behavior, writes a numbered walkthrough, then builds the code map and concept modules.
After merging a feature branch: "sync the docs" → patches only the owning page and appends Synced through <sha> to change-log.md.
"Where is request auth handled?" → answers from the existing guide if it is still accurate, or patches the smallest wrong page and answers with a link.
"Delete the generated repo docs" → removes the package plus stale root-agent pointers without recreating them.

· · · Install guide · · ·

Try it now, no install

Paste this into Claude to use the skill without installing anything.

Read the instructions in this file and follow them to help me:
https://raw.githubusercontent.com/YurunChen/repo-docs-skills/HEAD/docs/SKILL.md

What I want: (describe your task here)

If Claude can't open the link, open it yourself and paste the contents instead.

↓ If it works for you, download the ZIP below and install it. Then it runs on its own — no pasting each time.

Install in the Claude app (no terminal)

Download the ZIP with the button below.
In Claude, open Settings → Capabilities and turn on 'Code execution and file creation'. (one time)
Go to Customize → Skills → + → 'Upload a skill' and upload the ZIP.

↓ Download ZIP

Install in Claude Code

Let Claude do it — paste this into Claude Code

Install the skill I found on Claude Skill Mart.
Copy the docs folder from the GitHub repo YurunChen/repo-docs-skills into my ~/.claude/skills/repo-docs/.
When it's done, tell me in one line what this skill can do.

Install with a command instead

git clone https://github.com/YurunChen/repo-docs-skills.git /tmp/repo-docs-skills && cp -r /tmp/repo-docs-skills/docs ~/.claude/skills/repo-docs

⚠ This is a third-party skill. Check the source repository before installing.

Open a terminal.
Create the skills directory if needed: mkdir -p ~/.claude/skills
Clone the repository: git clone https://github.com/YurunChen/repo-docs-skills.git /tmp/repo-docs-skills
Copy the skill into place: cp -r /tmp/repo-docs-skills/docs ~/.claude/skills/repo-docs
Optionally copy the repo-docs-zh folder too if you want the Chinese overlay.
Verify Python is available with python3 --version (needed for the bundled validator).
Restart Claude Code, open your target repository, and ask: "use repo-docs to document this repo".
When it finishes, confirm the validator passed: python scripts/validate_repo_docs.py repo-docs --repo-root .

View source on GitHub ↗