mirror of
https://github.com/luongnv89/claude-howto.git
synced 2026-07-25 11:40:52 +02:00
Luong NGUYEN
8f045173d1
* docs: sync to Claude Code v2.1.212 Bumps tutorial coverage from the v2.1.206 baseline (2026-07-11 sync) to v2.1.212, plus a repo-internal accuracy audit that surfaced defects independent of the version delta. Fixed: - Dead `#` memory-shortcut removed from 02-memory/README.md (two places documented a discontinued quick-memory-add pattern as working, directly contradicting the file's own commands table) - Auto mode opt-in -> opt-out on Bedrock/Vertex/Foundry (v2.1.207) - `auto` permission mode mislabeled "Research Preview" across 09-advanced-features/README.md, CATALOG.md, README.md, and the vi/ja/zh/uk translations (auto mode is GA, gated only by plan/model/provider) - `/fork` / `/branch` history corrected: they were a single aliased command only from v2.1.77 to v2.1.161, not "renamed" as previously stated - `effort` frontmatter enum in 04-subagents/README.md completed with `xhigh` - Bundled-skills count reconciled in CATALOG.md (9 -> 10) - INDEX.md Skills section count and Feature Coverage Matrix Total column fully recomputed and reconciled (Skills: 22, Plugins: 39) - Stale 2.1.160 footer cluster (5 files) bumped to 2.1.212 - QUICK_REFERENCE.md fully resynced (was 52 versions behind) - 02-memory/README.md's Memory Hierarchy section rewritten: replaced a fabricated 8-tier strict-precedence model with the verified structure (CLAUDE.md files are concatenated into context, not overridden; 4 real location tiers; rules and auto memory are separate mechanisms) - 02-memory/README.md's Memory Architecture diagram no longer conflates claude.ai's 24h synthesis cycle with Claude Code's continuous auto memory - Import recursion depth corrected (was documented as 5, actually 4 hops) Added: - Subagent output scanning (v2.1.210) documented in 04-subagents/README.md - Session-wide spawn caps (v2.1.212): WebSearch and subagent limits - MCP long-running-tool auto-backgrounding (v2.1.212) in 05-mcp/README.md - `claude auto-mode reset` and `/resume` picker (v2.1.212) - Screen reader mode (v2.1.208): --ax-screen-reader / CLAUDE_AX_SCREEN_READER - Task tool `mode` parameter deprecation note (v2.1.212) Known gaps (deferred, not fixed this pass): - 03-skills/blog-draft/ vs 03-skills/.claude/skills/blog-draft/: confirmed the latter is gitignored local testing scratch, not a repo duplicate * fix(INDEX): correct Skills row arithmetic and stale changelog notes INDEX.md's Skills header/matrix shipped as 22 (5+9+8) despite the PR's own CHANGELOG claiming it was fixed to 21 — three independent counts (file-type breakdown, filesystem listing, changelog intent) agree on 21; the Docs column was off by one. Also removes two stale CHANGELOG "Known gaps" entries this same PR already resolved (memory hierarchy rewrite, blog-draft gitignore confirmation) and adds the missing Fixed-section bullet documenting the memory hierarchy rewrite.
130 lines
2.8 KiB
Markdown
130 lines
2.8 KiB
Markdown
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="../../resources/logos/claude-howto-logo-dark.svg">
|
|
<img alt="Claude How To" src="../../resources/logos/claude-howto-logo.svg">
|
|
</picture>
|
|
|
|
# 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
|
|
|
|
```bash
|
|
/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:
|
|
```bash
|
|
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 18, 2026
|
|
**Claude Code Version**: 2.1.212
|
|
**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 5, Claude Sonnet 4.6, Claude Opus 4.8, Claude Haiku 4.5
|