Docs: add module guides for Sandbox, Correction Attempts, and Invariant Reconciliation #4848

Open
opened 2026-04-08 20:07:55 +00:00 by HAL9000 · 1 comment
Owner

Summary

Author module guides for three critical subsystems so developers have reference documentation within MkDocs:

  • Sandbox manager and checkpoint lifecycle
  • Correction attempts domain model and services
  • Invariant reconciliation actor and service

Each guide should follow the established Module Guides template (Purpose, Core Classes, Lifecycle, Testing, Related Documentation) and reference the relevant sections in docs/specification.md.

Acceptance Criteria

  • docs/modules/sandbox.md covers commit/rollback semantics, boundary algebra, and error handling guidance aligned with the specification
  • docs/modules/correction-attempts.md documents request/record models, correction service flows, cascade handling, and ValidationError behaviour
  • docs/modules/invariant-reconciliation.md explains scopes, conflict resolution, reconciliation actor results, and links to the enforcement records
  • MkDocs navigation includes all module guides under Module Guides
  • Documentation references specification sections by heading (no line numbers)
  • Examples compile against current domain/service APIs (field names and signatures)

Testing

  • nox -s docs -- serve (spot-check rendering)
## Summary Author module guides for three critical subsystems so developers have reference documentation within MkDocs: - Sandbox manager and checkpoint lifecycle - Correction attempts domain model and services - Invariant reconciliation actor and service Each guide should follow the established Module Guides template (Purpose, Core Classes, Lifecycle, Testing, Related Documentation) and reference the relevant sections in `docs/specification.md`. ## Acceptance Criteria - `docs/modules/sandbox.md` covers commit/rollback semantics, boundary algebra, and error handling guidance aligned with the specification - `docs/modules/correction-attempts.md` documents request/record models, correction service flows, cascade handling, and ValidationError behaviour - `docs/modules/invariant-reconciliation.md` explains scopes, conflict resolution, reconciliation actor results, and links to the enforcement records - MkDocs navigation includes all module guides under **Module Guides** - Documentation references specification sections by heading (no line numbers) - Examples compile against current domain/service APIs (field names and signatures) ## Testing - `nox -s docs -- serve` (spot-check rendering)
Author
Owner

Issue triaged by project owner:

  • State: Verified
  • Priority: Medium — module documentation for Sandbox, Correction Attempts, and Invariant Reconciliation
  • Story Points: 3 (M) — three module guides to write
  • MoSCoW: Should Have — documentation improves developer onboarding and maintainability
  • Milestone: v3.5.0 — these modules are implemented in v3.5.0

Automated by CleverAgents Bot
Supervisor: Project Owner | Agent: project-owner

Issue triaged by project owner: - **State**: Verified - **Priority**: Medium — module documentation for Sandbox, Correction Attempts, and Invariant Reconciliation - **Story Points**: 3 (M) — three module guides to write - **MoSCoW**: Should Have — documentation improves developer onboarding and maintainability - **Milestone**: v3.5.0 — these modules are implemented in v3.5.0 --- **Automated by CleverAgents Bot** Supervisor: Project Owner | Agent: project-owner
HAL9000 added this to the v3.5.0 milestone 2026-04-09 03:06:37 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference
cleveragents/cleveragents-core#4848
No description provided.