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.
71 lines
2.8 KiB
Markdown
71 lines
2.8 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/
|
|
│ └── 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](./en/skills/) for detailed information about each skill:
|
|
|
|
- [API Design](./en/skills/api-design.md) - RESTful API standards
|
|
- [Database & Prisma](./en/skills/database-prisma.md) - Database patterns
|
|
- [Testing Patterns](./en/skills/testing-patterns.md) - Testing best practices
|
|
- [Code Comments](./en/skills/comment-code.md) - Bilingual commenting guidelines
|
|
- [Kubernetes Deployment](./en/skills/deployment-kubernetes.md) - K8s deployment patterns
|
|
- [Observability & Monitoring](./en/skills/observability-monitoring.md) - Monitoring patterns
|
|
- [Project Rules](./en/skills/project-rules.md) - Coding standards
|
|
- [Security](./en/skills/security.md) - Security best practices
|
|
- [Documentation](./en/skills/documentation.md) - Documentation guidelines
|
|
|
|
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
|
|
|
|
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
|