Files
claude-howto/07-plugins/documentation/README.md
T
Luong NGUYEN 343d6f0f99 docs: sync to Claude Code v2.1.220
Bumps tutorial coverage from the v2.1.217 baseline (2026-07-22 sync) to
v2.1.220 — three contiguous releases (v2.1.218–v2.1.220).

Critical fixes:

- Nested subagent spawning is on by default again at depth 3 (v2.1.219).
  Five locations across 04-subagents, CATALOG, 10-cli and QUICK_REFERENCE
  stated it was disabled by default — true for v2.1.217–v2.1.218 only.
  CLAUDE_CODE_MAX_SUBAGENT_SPAWN_DEPTH=1 now disables rather than enables.
  All five carry an identical three-era history note.
- Claude Opus 5 is the default Opus model (v2.1.219). 10-cli asserted
  "Opus 4.8 remains the default"; Opus 5 was absent from every model table.
  Added to both model tables, 19 Compatible Models footers, and ~20
  effort-level enumerations.

Also fixed: fast-mode model list, auto-mode eligibility self-contradiction
in 09-advanced-features, stale CLAUDE_CODE_ENABLE_AUTO_MODE opt-in in
CATALOG, hook-event count disagreement (29/30 -> 31 across three files),
doc-generator skill name/directory mismatch, stale "May 2026" headings,
and the last three docs.anthropic.com links.

Added: DirectoryAdded hook, /deep-research explicit-invocation note,
/code-review background subagent, context:fork background default, agent
frontmatter hook workspace trust, dynamic workflow size guideline and
workflowSizeGuideline key, sandbox.network.strictAllowlist, MCP error
surfacing, stream-json nested subagent forwarding, frontmatter boolean
values, agent name ':' rejection, auto/plan-mode classifier changes, and
Opus 5 safety-classifier fallback.

Renamed the deep-research skill example to topic-research to stop it
shadowing the built-in; mirrored to vi/ja/uk. doc-generator rename
mirrored to ja/zh/uk.
2026-07-29 15:01:31 +07:00

2.8 KiB

Claude How To

Documentation Plugin

Comprehensive documentation generation and maintenance for your project.

Features

API documentation generation README creation and updates Documentation synchronization Code comment improvements Example generation

Installation

/plugin install documentation

What's Included

Slash Commands

  • /generate-api-docs - Generate API documentation
  • /generate-readme - Create or update README
  • /sync-docs - Sync docs with code changes
  • /validate-docs - Validate documentation

Subagents

  • api-documenter - API documentation specialist
  • code-commentator - Code comment improvements
  • example-generator - Code example creation

Templates

  • api-endpoint.md - API endpoint documentation template
  • function-docs.md - Function documentation template
  • adr-template.md - Architecture Decision Record template

MCP Servers

  • GitHub integration for documentation syncing

Usage

Generate API Documentation

/generate-api-docs

Create README

/generate-readme

Sync Documentation

/sync-docs

Validate Documentation

/validate-docs

Requirements

  • Claude Code 1.0+
  • GitHub access (optional)

Example Workflow

User: /generate-api-docs

Claude:
1. Scans all API endpoints in /src/api/
2. Delegates to api-documenter subagent
3. Extracts function signatures and JSDoc
4. Organizes by module/endpoint
5. Uses api-endpoint.md template
6. Generates comprehensive markdown docs
7. Includes curl, JavaScript, and Python examples

Result:
✅ API documentation generated
📄 Files created:
   - docs/api/users.md
   - docs/api/auth.md
   - docs/api/products.md
📊 Coverage: 23/23 endpoints documented

Templates Usage

API Endpoint Template

Use for documenting REST API endpoints with full examples.

Function Documentation Template

Use for documenting individual functions/methods.

ADR Template

Use for documenting architectural decisions.

Configuration

Set up GitHub token for documentation syncing:

export GITHUB_TOKEN="your_github_token"

Best Practices

  • Keep documentation close to code
  • Update docs with code changes
  • Include practical examples
  • Validate regularly
  • Use templates for consistency

Last Updated: July 29, 2026 Claude Code Version: 2.1.220 Sources: