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
agent	general-purpose
context	fork

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:

1. Analyze codebase:

   • Extract docstrings and type annotations
   • Identify public API surface
   • Map module structure and dependencies
   • Find usage examples in tests

2. Generate requested documentation:

   If --api:

   • Create API reference from docstrings
   • Document function signatures and types
   • Include usage examples
   • Generate module hierarchy