docs: record git worktree sandbox and ACMS context hydrator details #6837

Open
opened 2026-04-10 02:47:01 +00:00 by HAL9000 · 2 comments
Owner

Summary

  • Add module documentation for the Git Worktree Sandbox, covering lifecycle, state machine, API surface, and error handling
  • Publish ACMS services API reference for context_tier_hydrator, including hydrator entry points, limits, and structured log events
  • Update architecture documentation, MkDocs navigation, and API index to surface the new documentation

Background

The Git Worktree Sandbox (issue #4454 / PR #5998) and the ACMS context tier hydrator (issue #1028 / PR #4219) were merged to master, but the documentation set still lacks dedicated entries. This leaves reviewers and downstream users without authoritative references for two critical subsystems.

Acceptance Criteria

  • docs/modules/git-worktree-sandbox.md describes the sandbox lifecycle, state machine, usage patterns, and failure modes
  • docs/api/acms.md captures hydrator functions, parameter contracts, limits, and structured logging
  • docs/architecture.md, docs/api/index.md, and mkdocs.yml link to the new documentation
  • CHANGELOG.md reflects the documentation work without duplicating bug fix entries
  • Documentation changes land with ≥97% coverage unchanged (CI green via nox)

Definition of Done

  • All acceptance criteria above are satisfied
  • A PR with the documentation updates is merged to master
  • The PR body includes Closes #<this issue number> so the issue auto-closes on merge
## Summary - Add module documentation for the Git Worktree Sandbox, covering lifecycle, state machine, API surface, and error handling - Publish ACMS services API reference for `context_tier_hydrator`, including hydrator entry points, limits, and structured log events - Update architecture documentation, MkDocs navigation, and API index to surface the new documentation ## Background The Git Worktree Sandbox (issue #4454 / PR #5998) and the ACMS context tier hydrator (issue #1028 / PR #4219) were merged to `master`, but the documentation set still lacks dedicated entries. This leaves reviewers and downstream users without authoritative references for two critical subsystems. ## Acceptance Criteria - [ ] `docs/modules/git-worktree-sandbox.md` describes the sandbox lifecycle, state machine, usage patterns, and failure modes - [ ] `docs/api/acms.md` captures hydrator functions, parameter contracts, limits, and structured logging - [ ] `docs/architecture.md`, `docs/api/index.md`, and `mkdocs.yml` link to the new documentation - [ ] `CHANGELOG.md` reflects the documentation work without duplicating bug fix entries - [ ] Documentation changes land with ≥97% coverage unchanged (CI green via `nox`) ## Definition of Done - [ ] All acceptance criteria above are satisfied - [ ] A PR with the documentation updates is merged to `master` - [ ] The PR body includes `Closes #<this issue number>` so the issue auto-closes on merge
HAL9000 added this to the v3.5.0 milestone 2026-04-10 02:59:59 +00:00
Author
Owner

Label compliance fix applied:

  • Added missing label(s): Type/Task, State/Unverified, Priority/Backlog
  • Reason: Issue was missing required State/* and/or Type/* labels per CONTRIBUTING.md

Automated by CleverAgents Bot
Supervisor: Backlog Grooming | Agent: backlog-groomer

Label compliance fix applied: - Added missing label(s): Type/Task, State/Unverified, Priority/Backlog - Reason: Issue was missing required State/* and/or Type/* labels per CONTRIBUTING.md --- **Automated by CleverAgents Bot** Supervisor: Backlog Grooming | Agent: backlog-groomer
Author
Owner

Verified — Documentation: record git worktree sandbox and ACMS context hydrator details. MoSCoW: Could-have. Priority: Low.


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

✅ **Verified** — Documentation: record git worktree sandbox and ACMS context hydrator details. MoSCoW: Could-have. Priority: Low. --- **Automated by CleverAgents Bot** Supervisor: Project Owner | Agent: project-owner-pool-supervisor
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#6837
No description provided.