b933329539
Some checks failed
Deploy to Staging / Build Images (push) Has started running
Deploy to Staging / Deploy to Staging (push) Has been cancelled
Deploy to Staging / Verify Staging (push) Has been cancelled
Deploy to Staging / Notify Staging Ready (push) Has been cancelled
Deploy to Staging / Notify Staging Failure (push) Has been cancelled
29 lines
1.5 KiB
Markdown
29 lines
1.5 KiB
Markdown
# docs/
|
|
|
|
## Files
|
|
|
|
| File | What | When to read |
|
|
| ---- | ---- | ------------ |
|
|
| `README.md` | Documentation hub and navigation | Starting point for any docs |
|
|
| `PLATFORM-SERVICES.md` | 5-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 |
|
|
| `ADMIN.md` | Admin feature documentation | Admin role management, catalog CRUD |
|
|
| `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 |
|
|
| `UX-DEBUGGING.md` | UX debugging techniques | Debugging UI issues |
|
|
| `PROMPTS.md` | AI prompt templates | AI-assisted development |
|
|
|
|
## Subdirectories
|
|
|
|
| Directory | What | When to read |
|
|
| --------- | ---- | ------------ |
|
|
| `changes/` | Change logs and migration notes | Understanding historical changes |
|