1.4 KiB
1.4 KiB
docs/
Files
| File | What | When to read |
|---|---|---|
README.md |
Documentation hub and navigation | Starting point for any docs |
PLATFORM-SERVICES.md |
9-container architecture overview | Understanding system topology |
ARCHITECTURE-OVERVIEW.md |
Detailed architecture documentation | Deep dive into system design |
DATABASE-SCHEMA.md |
Database table definitions | Schema changes, data modeling |
DATABASE-MIGRATION.md |
Migration procedures | Running or writing migrations |
VEHICLES-API.md |
Vehicles API specification | Vehicle-related API work |
TESTING.md |
Testing strategy and commands | Writing or running tests |
E2E-TESTING.md |
End-to-end testing guide | Cypress E2E test setup |
SECURITY.md |
Security guidelines | Security considerations |
CICD-DEPLOY.md |
CI/CD and deployment | Pipeline configuration, deployments |
BUILD-SERVER-SETUP.md |
Build server setup | Infrastructure setup |
AUDIT.md |
Audit documentation | Security audits, compliance |
MVP-COLOR-SCHEME.md |
Color scheme reference | UI styling decisions |
LOGGING.md |
Unified logging system | Log levels, correlation IDs, Grafana |
ocr-pipeline-tech-stack.md |
OCR pipeline technology decisions | OCR architecture, Tesseract setup |
TIER-GATING.md |
Subscription tier gating rules | Feature access by tier, vehicle limits |