📚 Documentation Sections
Getting Started
Architecture
- Architecture Overview - System design and patterns
- CQRS Pattern - Command Query Responsibility Segregation
- CQRS Leave Management - Leave module CQRS implementation
- Outbox Pattern - Event sourcing with outbox
- Handler Organization - HTTP handler structure
- Shared Infrastructure - Common infrastructure components
API Documentation
- Leave Types API - Leave management endpoints
- REST & GraphQL Example - API usage examples
- GraphQL Workflow - GraphQL development guide
- GQLGEN Generated Code - GraphQL code generation
Modules
Module-specific documentation for each business domain.Infrastructure
- Deployment Quick Reference - Cheat sheet for deployment commands
- MongoDB Transactions - Transaction handling
- OpenTelemetry - Observability and tracing
- Outbox Quick Reference - Outbox pattern reference
- Rate Limiting - API rate limiting
Development
- Validation - Input validation guide
- Validation Middleware - Validation middleware setup
- Coding Conventions - Code style and standards
Integration Guides
- Authentication Module - Better Auth integration overview
- Quickstart - Quick setup guide
- Role Assignment - User role management
- Webhook Testing - Testing webhooks
🚀 Quick Links
- New to the project? Start with Getting Started
- Understanding the system? Check Architecture
- Building APIs? See API Documentation
- Setting up auth? Follow Authentication Module
📖 Documentation Standards
All documentation follows these conventions:- Markdown format for easy reading and Astro integration
- Numbered directories for logical ordering
- Frontmatter for metadata (title, description, date)
- Code examples with syntax highlighting
- Clear structure with headers and sections
🔍 Search Tips
Use your IDE’s search or Astro’s search functionality to find what you need:/- Quick searchCtrl/Cmd + F- Find in pageCtrl/Cmd + Shift + F- Find in all docs
Last Updated: 2025-12-24
Maintained By: Backend Team