Plan: Detailed Implementation Guide
On this page
Context
The existing roadmap.adoc provides a high-level strategic view of CRAIG’s 11 phases with interactive checklists. The user wanted a separate, detailed implementation guide that any developer could follow to build each phase — covering database schemas, API endpoints, service structure, event flows, and dependencies. This keeps the roadmap clean and strategic while providing a deep technical reference elsewhere.
Phase 1+2 were already implemented when this plan was created. The guide documents what was built and provides equivalent detail for Phases 3-11.
Status
Complete. The implementation guide is live at docs/modules/ROOT/pages/implementation-guide.adoc (~2400 lines covering all 11 phases).
Approach
Created a single page implementation-guide.adoc linked from both navigation and the roadmap.
Files Created/Modified
-
Created
docs/modules/ROOT/pages/implementation-guide.adoc— the detailed implementation guide -
Edited
docs/modules/ROOT/nav.adoc— added navigation entry after Roadmap -
Edited
docs/modules/ROOT/pages/roadmap.adoc— added cross-reference to the guide
Content Structure
| Section | Content |
|---|---|
Introduction |
Purpose, relationship to roadmap, common service pattern |
Shared Architecture |
Common pattern (Axum → SQLx → RabbitMQ → Rules Engine), shared crates, devstack, CI/CD |
Phase 1 — Foundation |
Workspace structure, shared crates, devstack, CI/CD |
Phase 2 — Rules Engine |
craig-rules service, database schema, API endpoints, zen-engine integration |
Phase 3 — Case Management |
craig-cases, 13 tables, 33 endpoints, 8 events, rules integration |
Phase 4 — Placement |
craig-placement, foster homes, placements, kinship, matching |
Phase 5 — Data Exchange |
craig-exchange, ICPC, adapter pattern, data sharing agreements |
Phase 6 — Financial |
craig-financial, payments, IV-E claiming, cost allocation |
Phase 7 — Reporting |
craig-reporting, AFCARS/NCANDS, data quality monitoring |
Phase 8 — Security |
craig-security, audit logging, archiving, NIST controls |
Phase 9 — CLI |
craig-cli, clap subcommands, output formatting, auth flow |
Phase 10 — Web UI |
craig-web BFF, Axum + Askama + htmx + Alpine.js |
Phase 11 — Portals |
Constituent and provider portals |
Each phase includes: service name/port, Cargo.toml dependencies, database schema (CREATE TABLE SQL), REST API endpoint table, RabbitMQ events, Rules Engine integration points, phase dependencies, and verification steps.