46 lines
1.3 KiB
Markdown
46 lines
1.3 KiB
Markdown
# Documentation
|
|
|
|
This directory contains documentation for the GoodGo Microservices Platform, organized by language.
|
|
|
|
## Structure
|
|
|
|
```
|
|
docs/
|
|
├── en/ # English documentation
|
|
│ ├── api/
|
|
│ ├── architecture/
|
|
│ ├── guides/
|
|
│ ├── onboarding/
|
|
│ └── runbooks/
|
|
├── vi/ # Vietnamese documentation (Tiếng Việt)
|
|
│ ├── api/
|
|
│ ├── architecture/
|
|
│ ├── guides/
|
|
│ ├── onboarding/
|
|
│ └── runbooks/
|
|
└── README.md # This file
|
|
```
|
|
|
|
## Available Documentation
|
|
|
|
### English (`/en`)
|
|
- **API**: OpenAPI specifications
|
|
- **Architecture**: System design and service communication patterns
|
|
- **Guides**: Development, deployment, getting started, troubleshooting
|
|
- **Onboarding**: New developer guide
|
|
- **Runbooks**: Incident response and rollback procedures
|
|
|
|
### Vietnamese (`/vi`)
|
|
- **API**: OpenAPI specifications
|
|
- **Architecture**: Thiết kế hệ thống và các mẫu giao tiếp service
|
|
- **Guides**: Development, deployment, bắt đầu, xử lý sự cố
|
|
- **Onboarding**: Hướng dẫn cho developer mới
|
|
- **Runbooks**: Phản ứng sự cố và quy trình rollback
|
|
|
|
## 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
|