mirror of
https://github.com/luongnv89/claude-howto.git
synced 2026-08-21 12:17:15 +02:00
Luong NGUYEN
b9a973bf32
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.
31 lines
1.4 KiB
Markdown
31 lines
1.4 KiB
Markdown
---
|
|
name: doc-refactor
|
|
description: Restructure project documentation for clarity and accessibility
|
|
---
|
|
|
|
# Documentation Refactor
|
|
|
|
Refactor project documentation structure adapted to project type:
|
|
|
|
1. **Analyze project**: Identify type (library/API/web app/CLI/microservices), architecture, and user personas
|
|
2. **Centralize docs**: Move technical documentation to `docs/` with proper cross-references
|
|
3. **Root README.md**: Streamline as entry point with overview, quickstart, modules/components summary, license, contacts
|
|
4. **Component docs**: Add module/package/service-level README files with setup and testing instructions
|
|
5. **Organize `docs/`** by relevant categories:
|
|
- Architecture, API Reference, Database, Design, Troubleshooting, Deployment, Contributing (adapt to project needs)
|
|
6. **Create guides** (select applicable):
|
|
- User Guide: End-user documentation for applications
|
|
- API Documentation: Endpoints, authentication, examples for APIs
|
|
- Development Guide: Setup, testing, contribution workflow
|
|
- Deployment Guide: Production deployment for services/apps
|
|
7. **Use Mermaid** for all diagrams (architecture, flows, schemas)
|
|
|
|
Keep docs concise, scannable, and contextual to project type.
|
|
|
|
---
|
|
**Last Updated**: August 4, 2026
|
|
**Claude Code Version**: 2.1.220
|
|
**Sources**:
|
|
- https://code.claude.com/docs/en/commands
|
|
**Compatible Models**: Claude Fable 5, Claude Opus 5, Claude Sonnet 5, Claude Sonnet 4.6, Claude Opus 4.8, Claude Haiku 4.5
|