repo-docs

Generate and maintain README, API, architecture, changelog, and handoff documentation for codebases.

2|Updated Jul 28, 2026
One-click install
npx skills add https://github.com/mbadali25/useful-claude-add-ons --skill repo-docs-mbadali25
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: repo-docs
Source: https://github.com/mbadali25/useful-claude-add-ons/tree/main/skills/repo-docs
Command: npx skills add https://github.com/mbadali25/useful-claude-add-ons --skill repo-docs-mbadali25

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve? Codebase documentation drifts out of date quickly, and writing a full doc set (README, API reference, architecture, changelog, security, handoff notes) by hand is slow and error-prone. This Skill generates the complete documentation set grounded in the actual source code and keeps it refreshable across runs without overwriting human edits. ## Core Features & Use Cases - Full documentation set generation: Produces CLAUDE.md, root and per-directory READMEs, docs/API.md, docs/ARCHITECTURE.md, TODO.md, SECURITY.md, CHANGELOG.md, and docs/HANDOFF.md in dependency order. - Idempotent refresh: Uses managed content blocks with hashes and a docs/.repo-docs.json manifest so re-runs update only generated sections and preserve human edits. - Repo survey and changelog scripts: Includes repo_survey.py for inventorying languages, entry points, routes, env vars, and secrets, plus git_changelog.py for drafting Keep a Changelog entries from git history. - Use Case: After a large refactor, ask the Skill to refresh the repo docs; it surveys what changed since the last run, updates only the affected sections, drafts new changelog entries, and reports anything it could not verify. ## Quick Start Ask the assistant to document this repository and generate the full documentation set including README, architecture, API reference, and changelog.

Frequently Asked Questions about repo-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate documentation for an entire codebase automatically?

Run the repo-docs workflow, which surveys the repository with repo_survey.py, reads entry points and routes, then writes CLAUDE.md, READMEs, API reference, architecture, TODO, SECURITY, CHANGELOG, and handoff docs in dependency order. Every claim is grounded in actual source files.

How do I update stale README and API docs after a refactor?

Use the refresh mode: the survey script compares the current commit against the docs/.repo-docs.json manifest to list changed files, then only the managed content blocks affected by those changes are rewritten. Human-authored text outside the markers is left untouched.

Can I generate a changelog from git commit history?

Yes. The git_changelog.py script groups commits since the last tag into Keep a Changelog categories using conventional commit prefixes and keyword heuristics. Treat the output as a draft and rewrite entries in user-facing language before committing.

Does automated documentation work for large repositories?

Yes, by sampling deliberately: entry points, route definitions, config, and schema files are read in full, while the rest is described at directory granularity using the survey's language and size breakdown. The docs state which parts were surveyed shallowly.

How does the skill avoid leaking secrets into generated docs?

It documents that a secret exists and where it is read from, never the value. The repo_survey.py --secrets-scan option flags credential-shaped strings in output files, and any live credential found in the repo is reported to the user as a SECURITY.md finding.