docs-generate

Generate or update docs from code annotations, docstrings, and git history. Use when wanting API reference, README from code, or CHANGELOG from conventional commits.

Jump to install

Repository: laurigates/claude-plugins
Last source activity: July 28, 2026 at 18:09
Detected SKILL.md language: English
Stars: 49
Forks: 7

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

A direct command skips the review prompt. Inspect the source before running it.

npx skills add https://github.com/laurigates/claude-plugins --skill docs-generate

The command stays on one line. Scroll horizontally to inspect it before copying.

Prefer a local copy? Download the files currently available to SkillsMP.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

SKILL.md

Source instructions · Read-only preview

Back to search Back to installation

When to Use This Skill

Use this skill when...	Use docs-sync instead when...
Generating fresh API reference docs from docstrings, type signatures, and module structure	Reconciling existing skill/command/agent catalogs with the current codebase
Updating README.md from code analysis (installation steps, feature list, badges)	Fixing wrong counts or stale entries in CLAUDE.md / README catalogs
Producing a CHANGELOG from conventional-commit history	Preparing a service teardown checklist (use docs-decommission)
Building documentation pages that will be served via GitHub Pages or similar	Converting Markdown to print-ready PDF (use docs-latex)

Context

Project files: !find . -maxdepth 1 \( -name 'pyproject.toml' -o -name 'package.json' -o -name 'Cargo.toml' -o -name 'go.mod' \)
Existing docs: !find . -maxdepth 1 \( -name 'README.md' -o -type d -name 'docs' \)
Source files: !find . -type f \( -name "*.py" -o -name "*.ts" -o -name "*.js" \)
Python files: !find . -type f -name "*.py" -not -path '*/node_modules/*' -not -path '*/.claude/worktrees/*'

Parameters

--api: Generate API reference documentation
--readme: Update README.md based on code analysis
--changelog: Update CHANGELOG.md from git history

Your task

Delegate this task to the agents-plugin:docs agent.

Use the Agent tool with subagent_type: agents-plugin:docs to generate or update project documentation. Pass all the context gathered above and the parsed parameters to the agent.

The docs agent should:

Analyze codebase:
- Extract docstrings and type annotations
- Identify public API surface
- Map module structure and dependencies
- Find usage examples in tests
Generate requested documentation:

If --api:
- Create API reference from docstrings
- Document function signatures and types
- Include usage examples
- Generate module hierarchy
If --readme:
- Update project description
- Document installation steps
- Add usage examples
- Update feature list
- Ensure badges are current
If --changelog:
- Parse conventional commits
- Group by version/release
- Categorize by type (feat, fix, docs, etc.)
- Include breaking changes prominently
If no flags: Generate all documentation
Follow documentation standards:
- Clear, concise language
- Consistent formatting
- Working code examples
- Accurate cross-references
Output summary:
- Files created/updated
- Documentation coverage metrics
- Suggested improvements

Provide the agent with:

All context from the section above
The parsed parameters
Detected documentation framework (if any)

The agent has expertise in:

Multi-language documentation extraction
API reference generation
README best practices
Changelog automation from commits
GitHub Pages integration

Agent Teams (Optional)

For large projects, spawn teammates for parallel documentation generation:

Teammate	Focus	Value
API docs teammate	Extract and generate API reference	Parallel with README generation
README teammate	Update project README and guides	Parallel with API docs
Changelog teammate	Generate changelog from git history	Independent of other doc tasks

This is optional — the skill works with a single agent for most projects.

created	"2025-12-16T00:00:00.000Z"
modified	"2026-07-04T00:00:00.000Z"
reviewed	"2026-04-25T00:00:00.000Z"
allowed-tools	Task, TodoWrite
args	[--api] [--readme] [--changelog]
argument-hint	[--api] [--readme] [--changelog]
description	Generate or update docs from code annotations, docstrings, and git history. Use when wanting API reference, README from code, or CHANGELOG from conventional commits.
name	docs-generate

created	"2025-12-16T00:00:00.000Z"
modified	"2026-07-04T00:00:00.000Z"
reviewed	"2026-04-25T00:00:00.000Z"
allowed-tools	Task, TodoWrite
args	[--api] [--readme] [--changelog]
argument-hint	[--api] [--readme] [--changelog]
description	Generate or update docs from code annotations, docstrings, and git history. Use when wanting API reference, README from code, or CHANGELOG from conventional commits.
name	docs-generate