# GoodGo Platform Documentation

Welcome to the GoodGo Platform documentation. This directory contains comprehensive documentation for the entire platform.

## Documentation Structure

```
docs/
├── en/                    # English documentation
│   ├── templates/        # Documentation templates (EN)
│   ├── architecture/     # System architecture and design
│   ├── guides/          # Step-by-step guides
│   └── skills/          # Development patterns and skills
└── vi/                   # Vietnamese documentation
    ├── templates/        # Documentation templates (VI)
    ├── architecture/     # Kiến trúc hệ thống
    ├── guides/          # Hướng dẫn từng bước
    └── skills/          # Patterns và kỹ thuật phát triển
```

## 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. Choose appropriate template from `/en/templates/` or `/vi/templates/`
2. Add English version to `/en` directory
3. Add Vietnamese translation to `/vi` directory
4. Keep both versions in sync
5. Update this README if adding new categories

### Documentation Templates

- **English Templates**: [`docs/en/templates/`](./en/templates/)
  - `architecture.md` - Architecture documentation
  - `guide.md` - Step-by-step guides
  - `skill-pattern.md` - Coding patterns and skills
  - `README.md` - Template usage guide
  
- **Vietnamese Templates**: [`docs/vi/templates/`](./vi/templates/)
  - `architecture.md` - Tài liệu kiến trúc
  - `guide.md` - Hướng dẫn từng bước
  - `skill-pattern.md` - Coding patterns và skills
  - `README.md` - Hướng dẫn sử dụng templates

When updating Cursor Skills:
1. Update skill source in `.cursor/skills/{skill-name}/SKILL.md`
2. Update documentation in `docs/en/skills/{skill-name}.md` and `docs/vi/skills/{skill-name}.md`
3. Update skills index files if needed
