Loreax Documentation
Last Updated: April 27, 2026
Core Documentation
Technical Design & Architecture
- Technical Design Document — Complete system specification (canonical reference)
- AI Agent Brief — Quick reference for AI code generation agents
- Domain Documentation — Domain-specific implementation guides
Development Guides
- OpenAPI Generation — Generate and manage API documentation
- API Root Endpoint — API discovery, health monitoring, and documentation navigation
- Environment Variables Setup — Production environment configuration
Identity & Authorization
- Identity Domain — Authentication, MFA, and user management
- Wikis: Domain-specific implementation guides in
./wikis/
Deployment Documentation
- Environment Variables — Required reading for production deployments
- Deployment Overview — EC2, Kubernetes, and CI/CD configuration
Quick Links
| Need | Document |
|---|---|
| Complete system spec | loreax-technical-design.md |
| Agent implementation rules | ../AGENTS.md |
| Working with Claude | ../CLAUDE.md |
| Implementation progress | ../IMPLEMENTATION_PLAN.md |
| Generate API docs | development/OPENAPI_GENERATION.md |
| Production env setup | deployment/ENV_VARIABLES.md |
API Reference
Interactive API documentation is available at /docs/api when the application is running.
To regenerate:
php artisan loreax:openapi:generate
See OpenAPI Generation Guide for details.