docs: add comprehensive project documentation
Build and Deploy / Build & Push (push) Successful in 1m31s
Build and Deploy / Build & Push (push) Successful in 1m31s
Add docs/ folder with architecture, operations, API reference, and development guides covering system design, deployment, troubleshooting, all backend endpoints, and contributor workflows. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -14,6 +14,15 @@ A week-by-week calendar showing operating hours for all Six Flags Entertainment
|
||||
| **Texas & South** | Over Texas, Fiesta Texas (TX), Frontier City (OK) |
|
||||
| **West & International** | Magic Mountain (CA), Discovery Kingdom (CA), Knott's Berry Farm (CA), California's Great America (CA), Mexico |
|
||||
|
||||
## Documentation
|
||||
|
||||
Detailed docs live in the [`docs/`](docs/) folder:
|
||||
|
||||
- [**Architecture**](docs/ARCHITECTURE.md) -- system design, data flow, caching layers, database schema, external APIs
|
||||
- [**Operations**](docs/OPERATIONS.md) -- deployment, monitoring, troubleshooting, backup, scheduler management
|
||||
- [**API Reference**](docs/API.md) -- complete backend endpoint documentation with request/response examples
|
||||
- [**Development**](docs/DEVELOPMENT.md) -- local setup, project structure, adding parks, testing, code conventions
|
||||
|
||||
## Architecture
|
||||
|
||||
The app runs as two containers:
|
||||
|
||||
Reference in New Issue
Block a user