7f2e77337e
Update all documentation footers from generic "April 2026 / 2.1+" to the specific sync date (April 9, 2026) and documented version (2.3.0). Also add version/date footers to zh/CATALOG.md and zh/01-slash-commands/README.md which were missing them. Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
28 lines
1.3 KiB
Markdown
28 lines
1.3 KiB
Markdown
---
|
|
name: Documentation Refactor
|
|
description: Restructure project documentation for clarity and accessibility
|
|
tags: documentation, refactoring, organization
|
|
---
|
|
|
|
# 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**: April 9, 2026
|