feat: Bổ sung tài liệu kiến trúc, các mẫu hướng dẫn và phân tích, cùng với hướng dẫn Mermaid song ngữ.
This commit is contained in:
@@ -1,26 +1,21 @@
|
||||
# Documentation
|
||||
# GoodGo Platform Documentation
|
||||
|
||||
This directory contains documentation for the GoodGo Microservices Platform, organized by language.
|
||||
Welcome to the GoodGo Platform documentation. This directory contains comprehensive documentation for the entire platform.
|
||||
|
||||
## Structure
|
||||
## Documentation Structure
|
||||
|
||||
```
|
||||
docs/
|
||||
├── en/ # English documentation
|
||||
│ ├── api/
|
||||
│ ├── architecture/
|
||||
│ ├── guides/
|
||||
│ ├── onboarding/
|
||||
│ ├── runbooks/
|
||||
│ └── skills/ # Cursor AI skills documentation
|
||||
├── vi/ # Vietnamese documentation (Tiếng Việt)
|
||||
│ ├── api/
|
||||
│ ├── architecture/
|
||||
│ ├── guides/
|
||||
│ ├── onboarding/
|
||||
│ ├── runbooks/
|
||||
│ └── skills/ # Tài liệu Cursor AI skills
|
||||
└── README.md # This file
|
||||
├── en/ # English documentation
|
||||
│ ├── templates/ # Documentation templates (EN)
|
||||
│ ├── architecture/ # System architecture and design
|
||||
│ ├── guides/ # Step-by-step guides
|
||||
│ └── skills/ # Development patterns and skills
|
||||
└── vi/ # Vietnamese documentation
|
||||
├── templates/ # Documentation templates (VI)
|
||||
├── architecture/ # Kiến trúc hệ thống
|
||||
├── guides/ # Hướng dẫn từng bước
|
||||
└── skills/ # Patterns và kỹ thuật phát triển
|
||||
```
|
||||
|
||||
## Available Documentation
|
||||
@@ -60,11 +55,27 @@ See [Skills Index](./en/skills/README.md) for complete list and quick reference.
|
||||
## Contributing
|
||||
|
||||
When adding new documentation:
|
||||
1. Add the English version to `/en`
|
||||
2. Add the Vietnamese translation to `/vi`
|
||||
3. Keep both versions in sync
|
||||
1. Choose appropriate template from `/en/templates/` or `/vi/templates/`
|
||||
2. Add English version to `/en` directory
|
||||
3. Add Vietnamese translation to `/vi` directory
|
||||
4. Keep both versions in sync
|
||||
5. Update this README if adding new categories
|
||||
|
||||
### Documentation Templates
|
||||
|
||||
- **English Templates**: [`docs/en/templates/`](./en/templates/)
|
||||
- `architecture.md` - Architecture documentation
|
||||
- `guide.md` - Step-by-step guides
|
||||
- `skill-pattern.md` - Coding patterns and skills
|
||||
- `README.md` - Template usage guide
|
||||
|
||||
- **Vietnamese Templates**: [`docs/vi/templates/`](./vi/templates/)
|
||||
- `architecture.md` - Tài liệu kiến trúc
|
||||
- `guide.md` - Hướng dẫn từng bước
|
||||
- `skill-pattern.md` - Coding patterns và skills
|
||||
- `README.md` - Hướng dẫn sử dụng templates
|
||||
|
||||
When updating Cursor Skills:
|
||||
1. Update the skill source file in `.cursor/skills/{skill-name}/SKILL.md`
|
||||
2. Update the documentation in `docs/en/skills/{skill-name}.md` and `docs/vi/skills/{skill-name}.md`
|
||||
3. Update the skills index files if needed
|
||||
1. Update skill source in `.cursor/skills/{skill-name}/SKILL.md`
|
||||
2. Update documentation in `docs/en/skills/{skill-name}.md` and `docs/vi/skills/{skill-name}.md`
|
||||
3. Update skills index files if needed
|
||||
|
||||
Reference in New Issue
Block a user