chore: Update Documentation
All checks were successful
Deploy to Staging / Build Images (push) Successful in 2m19s
Deploy to Staging / Deploy to Staging (push) Successful in 27s
Deploy to Staging / Verify Staging (push) Successful in 5s
Deploy to Staging / Notify Staging Ready (push) Successful in 5s
Deploy to Staging / Notify Staging Failure (push) Has been skipped
Mirror Base Images / Mirror Base Images (push) Successful in 29s

This commit is contained in:
Eric Gullickson
2026-01-03 15:10:19 -06:00
parent 485bfd3dfc
commit 3053b62fa5
8 changed files with 1149 additions and 273 deletions

View File

@@ -115,12 +115,29 @@
"description": "Admin role management, platform catalog CRUD, station oversight",
"status": "implemented"
},
"vehicles": {
"path": "backend/src/features/vehicles/",
"auth": {
"path": "backend/src/features/auth/",
"type": "core_feature",
"self_contained": true,
"database_tables": ["vehicles"],
"cache_strategy": "User vehicle lists: 5 minutes",
"database_tables": [],
"description": "User signup, email verification workflow using Auth0",
"status": "implemented"
},
"backup": {
"path": "backend/src/features/backup/",
"type": "admin_feature",
"self_contained": true,
"database_tables": ["backup_schedules", "backup_history", "backup_settings"],
"storage": "/app/data/backups/",
"description": "Manual and scheduled database/document backups with retention policies",
"status": "implemented"
},
"documents": {
"path": "backend/src/features/documents/",
"type": "independent_feature",
"self_contained": true,
"database_tables": ["documents"],
"storage": "/app/data/documents/",
"status": "implemented"
},
"fuel-logs": {
@@ -141,21 +158,23 @@
"cache_strategy": "Upcoming maintenance: 1 hour",
"status": "implemented"
},
"stations": {
"path": "backend/src/features/stations/",
"type": "independent_feature",
"notifications": {
"path": "backend/src/features/notifications/",
"type": "dependent_feature",
"self_contained": true,
"external_apis": ["Google Maps API"],
"database_tables": ["stations", "community_stations"],
"cache_strategy": "Station searches: 1 hour",
"depends_on": ["maintenance", "documents"],
"database_tables": ["email_templates", "notification_logs", "sent_notification_tracker", "user_notifications"],
"external_apis": ["Resend"],
"description": "Email and toast notifications for maintenance due/overdue and expiring documents",
"status": "implemented"
},
"documents": {
"path": "backend/src/features/documents/",
"type": "independent_feature",
"onboarding": {
"path": "backend/src/features/onboarding/",
"type": "dependent_feature",
"self_contained": true,
"database_tables": ["documents"],
"storage": "/app/data/documents/",
"depends_on": ["user-profile", "user-preferences"],
"database_tables": [],
"description": "User onboarding flow after email verification (preferences, first vehicle)",
"status": "implemented"
},
"platform": {
@@ -166,11 +185,61 @@
"cache_strategy": "Vehicle hierarchical data: 6 hours",
"description": "Vehicle hierarchical data lookups (years, makes, models, trims, engines). VIN decoding is planned/future.",
"status": "implemented_vin_decode_planned"
},
"stations": {
"path": "backend/src/features/stations/",
"type": "independent_feature",
"self_contained": true,
"external_apis": ["Google Maps API"],
"database_tables": ["stations", "community_stations"],
"cache_strategy": "Station searches: 1 hour",
"status": "implemented"
},
"terms-agreement": {
"path": "backend/src/features/terms-agreement/",
"type": "core_feature",
"self_contained": true,
"database_tables": ["terms_agreements"],
"description": "Legal audit trail for Terms & Conditions acceptance at signup",
"status": "implemented"
},
"user-export": {
"path": "backend/src/features/user-export/",
"type": "independent_feature",
"self_contained": true,
"depends_on": ["vehicles", "fuel-logs", "documents", "maintenance"],
"database_tables": [],
"description": "GDPR-compliant user data export (vehicles, logs, documents as TAR.GZ)",
"status": "implemented"
},
"user-preferences": {
"path": "backend/src/features/user-preferences/",
"type": "core_feature",
"self_contained": true,
"database_tables": ["user_preferences"],
"description": "User preference management (unit system, currency, timezone)",
"status": "implemented"
},
"user-profile": {
"path": "backend/src/features/user-profile/",
"type": "core_feature",
"self_contained": true,
"database_tables": ["user_profiles"],
"description": "User profile management (email, display name, notification email)",
"status": "implemented"
},
"vehicles": {
"path": "backend/src/features/vehicles/",
"type": "core_feature",
"self_contained": true,
"database_tables": ["vehicles"],
"cache_strategy": "User vehicle lists: 5 minutes",
"status": "implemented"
}
},
"feature_dependencies": {
"explanation": "Logical dependencies within single application service - all deploy together",
"sequence": ["admin", "platform", "vehicles", "fuel-logs", "maintenance", "stations", "documents"]
"sequence": ["admin", "auth", "user-profile", "user-preferences", "terms-agreement", "onboarding", "platform", "vehicles", "fuel-logs", "maintenance", "stations", "documents", "notifications", "backup", "user-export"]
},
"development_environment": {
"type": "production_only_docker",
@@ -206,7 +275,8 @@
},
"external_apis": [
"Google Maps API",
"Auth0"
"Auth0",
"Resend"
]
},
"network_topology": {