29c40ea681
- Enhanced `README.md` with a quick start guide and detailed project structure. - Updated `SETUP_GUIDE.md` by removing it as it was redundant. - Improved `local-development.md` and `development.md` with clearer instructions for database migrations. - Added bilingual comments in various scripts for better understanding and usability. - Updated `.gitignore` to include specific build scripts while ignoring others. - Enhanced `scripts` for database management, including backup and seeding functionalities with bilingual support.
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:
- Add the English version to
/en - Add the Vietnamese translation to
/vi - Keep both versions in sync