Skip to content

Latest commit

 

History

History
49 lines (45 loc) · 3.43 KB

NEXT_STEPS.md

File metadata and controls

49 lines (45 loc) · 3.43 KB

NEXT_STEPS: User Documentation & Quality Assurance

Current Context

  • Documentation: Drafted core user guides (concepts/architecture.md, concepts/core-model.md, reference/api.md, guides/mcp.md).
  • Phase 16 (QA): Test coverage goals met for API/Store/Engine.
  • Phase 14 & 15: Complete.

Immediate Actions

  • Review Documentation: Verify the newly created user docs in docs/ align with the implementation and are clear.
  • M42.4 (Audit): Updated docs/index.md to link all guides (web-ui.md, cli.md) and verified docs/installation.md and docs/configuration.md.
  • M42.5 (Improvement): Enhanced docs/installation.md, switched to YAML in docs/configuration.md & docs/guides/deployment.md, and implemented YAML support in pkg/engine.
  • M42.3 (Refined): Added Policy Guide and moved/refined Deployment Guide.
  • SDK Docs: Refreshed JS, Python, and Go SDK documentation to remove draft warnings and match implementation.
  • M42.5+: Refined Policy Guide (Shared vs Isolated) and Configuration Guide (Defaults).
  • MCP Guide: Created docs/guides/mcp.md and linked from index.
  • Docs Polish: Added Financial Governance to Policy Guide and Cluster Federation to Deployment Guide.
  • Project Assessment: Updated ASSESSMENT.md with "Vision Alignment Gaps" and TASKS.md with Post-1.0 roadmap.
  • M43.1 (Reports): Implement real CSV generation in pkg/reports/csv.go and add tests.
  • M43.2 (Graph): Implement PolicyUpdated handling in pkg/graph/projection.go and add adjacency index.
  • M43.3 (Hardening): Fix hardcoded resetAt, fix API pool ID, and add tests for pkg/mcp and pkg/blob.
  • M43.4 (Cleanup): Address TODOs in Federation, Poller, and Provider packages (from Assessment).
  • M43.6 (Quick Fixes): Inject Provider Version at build time (from latest Assessment).
  • Fix Web Build: Resolve duplicate keys error in src/features/graph/GraphView.tsx.
  • M43.5 (Final Validation): Run full simulation and acceptance suite before final sign-off (Fixed auth bug in ratelord-sim).
  • M45.1 (Web UI): Implement simulation UI in modern typescript (Simulation tab).
  • M45.2 (Integration): Connect UI to simulation backend (Implemented pkg/simulation and /v1/simulation).
  • Phase 16 Continues: Final pre-release validation and debt paydown. (Fixed: Test imports, Web UI unused imports).
  • M48.1 (Docker): Create Dockerfile and docker-compose.yml for full system stack.
  • M48.2 (E2E): Implement tests/e2e suite and run it against the docker stack.

Phase History

  • M42.1, M42.2, M42.3: User Documentation (Concepts, API Ref, Guides).
  • M41.3: Engine Package Coverage (Achieved 80.9%).
  • M41.2: Store Package Coverage (Achieved 80.8%).
  • M41.1: API Package Coverage (Achieved 80.1%).
  • M31.3: Documentation & Changelog (Release Automation).
  • M37.3: Policy Debugging (Trace Mode & UI).
  • M36.3: Compliance & Deletion (GDPR support).
  • M36.2: Cold Storage Offload (ArchiveWorker + LocalBlobStore).
  • Epic 40: Client Resilience (M40.1, M40.2, M40.3).
  • Epic 33: High Availability (M33.1, M33.4).
  • Epic 35: Canonical Constraint Graph.
  • Epic 39: MCP Integration.
  • M36.1: Retention Policy Engine.

Reference

  • Spec: CLIENT_SDK_SPEC.md
  • Plan: TASKS.md
  • Progress: PROGRESS.md