47c5676498
Some checks failed
Deploy to Staging / Build Images (pull_request) Failing after 7m4s
Deploy to Staging / Deploy to Staging (pull_request) Has been skipped
Deploy to Staging / Verify Staging (pull_request) Has been skipped
Deploy to Staging / Notify Staging Ready (pull_request) Has been skipped
Deploy to Staging / Notify Staging Failure (pull_request) Successful in 7s
Add engine abstraction tests and update docs to reflect PaddleOCR primary architecture with optional Google Vision cloud fallback. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
23 lines
1.4 KiB
Markdown
23 lines
1.4 KiB
Markdown
# 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, PaddleOCR engine abstraction |
|
|
| `TIER-GATING.md` | Subscription tier gating rules | Feature access by tier, vehicle limits |
|