mirror of https://github.com/luongnv89/claude-howto.git synced 2026-08-08 00:08:36 +02:00

Files

T

Luong NGUYENandGitHub b9a973bf32 docs: accuracy pass against Claude Code v2.1.220 (#155 )

Internal accuracy pass against v2.1.220 — no missing upstream features, but broken example code, disagreeing counts, and metadata drift.

Functional fixes: pre-commit.sh now exits 2 so it actually blocks; dependency-check.sh reads file_path from stdin JSON instead of $1; database-mcp.json uses ${DATABASE_URL}; broken fences repaired; three command templates had invalid skill names.

Factual corrections: /fork and /subtask unswapped and /subtask added; /fewer-permission-prompts; permissions.defaultMode; dontAsk/auto unreversed; 31 hook events verified name-by-name; subagent depth 3; skill precedence enterprise > project > personal; /output-style removed not deprecated; permissionDecision gained defer.

Follow-up review fixed defects the pass left behind: zh/vi headers claiming 31 events above 25-name lists, a surviving hardcoded DB credential in the MCP README examples, an unbalanced fence swallowing a metadata footer, and non-canonical tool names. All four translated CATALOG summary tables were recounted so their arithmetic holds.

Full detail in CHANGELOG.md under v2.1.220-r2.

2026-08-04 15:41:12 +07:00

2.9 KiB

Raw Blame History

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 2.1+
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: August 4, 2026 Claude Code Version: 2.1.220 Sources:

https://code.claude.com/docs/en/plugins
https://github.com/anthropics/claude-code/releases/tag/v2.1.131
https://github.com/anthropics/claude-code/releases/tag/v2.1.138
https://code.claude.com/docs/en/model-config Compatible Models: Claude Fable 5, Claude Opus 5, Claude Sonnet 5, Claude Sonnet 4.6, Claude Opus 4.8, Claude Haiku 4.5

2.9 KiB Raw Blame History