mirror of
https://github.com/luongnv89/claude-howto.git
synced 2026-06-01 10:31:33 +02:00
c08c293aa4
* docs: sync to Claude Code v2.1.156 and Claude Opus 4.8 Model bump Opus 4.7 -> Opus 4.8 and version sync v2.1.150 -> v2.1.156. - Rewrite effort-ladder claims for Opus 4.8 (default `high`; `xhigh` on 4.8/4.7; `max` on 4.8/4.7/4.6 and Sonnet 4.6; Haiku has no effort). - Replace soon-removed CLAUDE_CODE_OPUS_4_6_FAST_MODE_OVERRIDE with the `/model claude-opus-4-6[1m]` + `/fast on` path; note Opus 4.8 fast mode. - Bump lineup tables to Opus 4.8; fix Haiku 4.5 context (1M -> 200K). - Sweep Compatible Models + version/date footers to 2.1.156 / May 29, 2026 across 23 English docs (incl. 2.1.138/2.1.145 stragglers). - Re-document `/simplify` as a distinct cleanup-only command (v2.1.154). - Add Dynamic Workflows + `/workflows`, MessageDisplay hook (count 29->30), disallowed-tools frontmatter, `/reload-skills` + SessionStart outputs, `/model` default-save inversion, lean system prompt, status-line COLUMNS/LINES, and the ultracode `/effort` note. * docs(cli): drop unverified fast-mode dollar pricing, keep verified rate/speed multipliers
2.8 KiB
2.8 KiB
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 specialistcode-commentator- Code comment improvementsexample-generator- Code example creation
Templates
api-endpoint.md- API endpoint documentation templatefunction-docs.md- Function documentation templateadr-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: May 29, 2026 Claude Code Version: 2.1.156 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 Compatible Models: Claude Sonnet 4.6, Claude Opus 4.8, Claude Haiku 4.5