b104fafa85
- Renamed auth-service to iam-service across various files for consistency. - Updated Dockerfiles, deployment configurations, and documentation to reflect the service name change. - Enhanced testing commands in documentation to point to the new iam-service. - Removed outdated auth-service files and configurations to streamline the project structure. - Improved bilingual documentation for clarity on the new service structure and usage.
2.8 KiB
2.8 KiB
Documentation
This directory contains documentation for the GoodGo Microservices Platform, organized by language.
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
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
- Skills: Cursor AI skills documentation (API design, testing, security, etc.)
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
- Skills: Tài liệu Cursor AI skills (API design, testing, security, v.v.)
Cursor Skills
The project uses Cursor AI Skills to guide AI assistants in following project-specific patterns and standards. See the Skills Documentation for detailed information about each skill:
- API Design - RESTful API standards
- Database & Prisma - Database patterns
- Testing Patterns - Testing best practices
- Code Comments - Bilingual commenting guidelines
- Kubernetes Deployment - K8s deployment patterns
- Observability & Monitoring - Monitoring patterns
- Project Rules - Coding standards
- Security - Security best practices
- Documentation - Documentation guidelines
See Skills Index for complete list and quick reference.
Contributing
When adding new documentation:
- Add the English version to
/en - Add the Vietnamese translation to
/vi - Keep both versions in sync
When updating Cursor Skills:
- Update the skill source file in
.cursor/skills/{skill-name}/SKILL.md - Update the documentation in
docs/en/skills/{skill-name}.mdanddocs/vi/skills/{skill-name}.md - Update the skills index files if needed