ab44954bd6
- Updated `.gitignore` to clarify environment variable handling. - Enhanced `pnpm-lock.yaml` with new dependencies for Jest and Supertest, including type definitions. - Improved bilingual documentation in `SKILL.md` files for better clarity on comment patterns and project rules. - Refined `docker-compose.yml` for local development, adding detailed instructions and access points. - Updated environment variable example in `env.local.example` for better guidance on configuration. - Removed outdated architecture documentation from the service template. - Enhanced Dockerfile for improved security and performance during builds. - Added Swagger documentation setup in the service template for better API documentation. - Improved error handling and logging middleware for enhanced debugging capabilities.
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