Documentation Consistency Update

On this page

Status

COMPLETE

Context

The CRAIG codebase has evolved through Phases 6–8, Phase 12 (Public Intake), reference data work, code quality review, and E2E/CI improvements — but most documentation still reflected the state after Phase 5. Test counts, workspace member counts, service lists, and phase completion checkboxes were all stale. This plan updates all 8 documentation files to match the actual codebase state.

No code changes — documentation only, single commit.

Files Updated

1. README.adoc

  • WARNING text: "Phases 1–5 implemented; 6–11 planned" → "Phases 1–10 and 12 implemented. Phase 11 planned."

  • Prerequisites: added Node.js 18+ and cargo-nextest; updated Rust to "1.88+ MSRV"

  • Test command: cargo test --workspace → cargo nextest run --workspace --profile integration

  • Pre-push step 4: same nextest update

2. docs/modules/ROOT/pages/index.adoc

  • WARNING: "Phases 6–8, 11 are planned" → "Phase 11 is planned" (6–8 ARE implemented)

  • Added links to devstack guide, developer guide, deployment guide, state machines, glossary

3. CHANGELOG.adoc

  • Added Phase 7 (Reporting), Phase 8 (Security), Phase 12 (Public Intake) entries under "Added"

  • Updated Web UI description to "10 route modules"

  • E2E count: 74 → 103 tests, 14 → 17 spec files

  • Integration test count: 432 → 710+

  • Added craig-reference crate, E2E manifest integration, code quality review entries

  • Added code quality review under "Changed" (SecurityAddon, bootstrap, role consolidation, file splits, CI timeout)

4. docs/modules/ROOT/pages/roadmap.adoc

  • Typed service clients: added FinancialClient, ReportingClient, SecurityClient, IntakeClient

  • Checked ☑ E2E manifest integration

  • Checked ☑ Phase 12 E2E tests

  • Left unchecked: dashboard live stats (genuinely not done), reporting dashboard (genuinely not done)

5. docs/modules/ROOT/pages/developer-guide.adoc

  • Workspace count: "17 members" → "21 members"

  • Added craig-reference/, craig-intake-sdk/ to shared crates tree

  • Added craig-intake/ (port 8008) to services tree

  • Updated craig-api description: added bootstrap(), SecurityAddon, shutdown_signal()

  • Replaced manual 8-step boot with bootstrap() pattern

  • Role check example: require_role() → claims.require_caseworker_or_above()?

  • OpenAPI example: added use craig_api::SecurityAddon;

  • E2E note: cargo xtask e2e auto-rebuilds (removed manual docker compose build)

  • Pre-push step 4: nextest

  • CLI profile example: added financial, reporting, security, intake URLs

6. CONTRIBUTING.adoc

  • Testing command: added nextest as primary test command

7. docs/modules/ROOT/pages/deployment-guide.adoc

  • Service count: "8" → "9"

  • Added craig-intake row to service table (port 8008, craig_intake)

  • Added === craig-intake env var section

  • Added CRAIG_WEB__INTAKE_URL to craig-web env vars

  • Added docker build --target craig-intake to build commands

  • Added CREATE DATABASE craig_intake; to database list

  • Added craig-security to object storage services list

  • Added craig-intake to Swagger UI list

  • Added craig-intake to RabbitMQ queue table; updated craig-security to note wildcard # binding

8. docs/modules/ROOT/pages/devstack.adoc

  • Added "intake" to services startup list

  • Added craig-intake row to status example output

  • E2E count: "80 tests across 15 spec files" → "103 tests across 17 spec files"

  • Added craig-intake row to CRAIG Services table

  • Database count: "eight" → "nine"; added CREATE DATABASE craig_intake;

  • Integration test command: nextest

  • CLI profile example: added financial, reporting, security, intake URLs

Edit this page · latest