Complete reference for developers, users, and administrators
Last Updated: March 27, 2026 • Completeness: 95%
All user manuals created and available. Technical architecture documentation in place. Content management guides included.
For developers, architects, and engineering teams.
Complete module-level breakdown of backend API (28 routes, 15 services), frontend components (61 pages), mobile app architecture, database schema, real-time messaging, and payment flows.
View Architecture →✓ Complete
Detailed endpoint documentation with request/response samples, authentication, rate limiting, and error codes. Auto-generated from OpenAPI/Swagger.
⏳ Coming Soon — Generate from backend JSDoc/OpenAPI
❌ Not CreatedComplete ERD diagram, table definitions, relationships, indexes, migration history, and query optimization guide.
⏳ Coming Soon — Generate from migrations
❌ Not CreatedRole-specific guides with step-by-step instructions and best practices.
Complete guide for livestock transporters: signup, fleet setup, finding loads, bidding, contracts, trip execution, proof of delivery, earnings, and payouts.
Read Manual →✓ Complete
Complete guide for livestock owners: signup, posting loads, negotiating with haulers, contract creation, escrow payments, shipment tracking, delivery confirmation, and dispute handling.
Read Manual →✓ Complete
Quick guide for drivers: account activation, dashboard, viewing trips, starting trips, GPS tracking, pickup/delivery process, and logging expenses.
Read Manual →✓ Complete
Guide for vets, insurance providers, and service providers: posting services, managing bookings, payments, and communication.
⏳ Coming Soon
❌ Not CreatedFor platform administrators and operations teams.
Complete admin guide: user management, pricing configuration, subscription management, dispute resolution, financial monitoring, settlements, support tickets, content management, and reporting.
Read Manual →✓ Complete
Daily/weekly/monthly operations checklist, monitoring, incident response, scaling procedures, and disaster recovery.
⏳ Coming Soon
❌ Not CreatedRegulatory requirements, audit logging, data privacy (GDPR/CCPA), and livestock welfare regulations enforcement.
⏳ Coming Soon
❌ Not CreatedHigh-level project context and workflows (already in repo root).
Complete project overview covering all 4 codebases, tech stacks, user roles, features, deployment, environment setup, and current state. 200+ lines of detailed reference.
✓ Exists
End-to-end workflows from signup → payment → delivery. Complete lifecycle documentation with diagram and money flow illustration.
✓ Exists
Driver app integration guide and mobile app alignment plan with backend APIs, workflow mapping, and implementation phases.
✓ Exists
AI/ML strategy: LivestockLM language model, animal behavior detection, route optimization, demand forecasting, computer vision, and predictive maintenance.
✓ Exists
| Document | Format | Target Audience | Status | Location |
|---|---|---|---|---|
| Technical Module Architecture | HTML (interactive) | Developers, Architects | ✓ Complete | /docs/technical-architecture.html |
| Hauler User Manual | HTML (printable) | Hauler Users | ✓ Complete | /docs/user-manual-hauler.html |
| Shipper User Manual | HTML (printable) | Shipper Users | ✓ Complete | /docs/user-manual-shipper.html |
| Driver User Manual | HTML (printable) | Driver Users | ✓ Complete | /docs/user-manual-driver.html |
| Super Admin Manual | HTML (printable) | Admin Users | ✓ Complete | /docs/user-manual-admin.html |
| API Endpoints Reference | HTML / Swagger | Developers | ❌ Pending | — |
| Database Schema Reference | HTML / ERD | DBAs, Developers | ❌ Pending | — |
| Stakeholder User Manual | HTML (printable) | Stakeholder Users | ❌ Pending | — |
| Operations Runbook | HTML / Markdown | Operations Team | ❌ Pending | — |
| Compliance & Audit Guide | HTML / Markdown | Compliance, Legal | ❌ Pending | — |
| PROJECT_CONTEXT.md (Existing) | Markdown | All Teams | ✓ Complete | /PROJECT_CONTEXT.md |
| WORKFLOW.md (Existing) | Markdown | All Teams | ✓ Complete | /WORKFLOW.md |
| AGENT_AND_DRIVER_APP_OVERVIEW.md (Existing) | Markdown | Mobile Devs | ✓ Complete | /AGENT_AND_DRIVER_APP_OVERVIEW.md |
| AI_VISION.md (Existing) | Markdown | Architects, AI/ML | ✓ Complete | /AI_VISION.md |