Cleanup of documentation
This commit is contained in:
@@ -0,0 +1,102 @@
|
||||
---
|
||||
id: CUST-WP-0037
|
||||
type: workplan
|
||||
title: "Task-Flow Reference Documentation Cleanup"
|
||||
domain: custodian
|
||||
repo: the-custodian
|
||||
status: completed
|
||||
owner: custodian
|
||||
topic_slug: custodian
|
||||
created: "2026-05-01"
|
||||
updated: "2026-05-01"
|
||||
state_hub_workstream_id: "599d3c40-9f99-466f-b30d-f9d64317345c"
|
||||
---
|
||||
|
||||
# CUST-WP-0037 — Task-Flow Reference Documentation Cleanup
|
||||
|
||||
## Goal
|
||||
|
||||
Update Custodian reference materials after the task-flow-engine terminology has
|
||||
landed in State Hub. Retire wording that assumes fixed lifecycle enums and
|
||||
replace it with the new model of information objects, workstations, and
|
||||
requisite assertions.
|
||||
|
||||
This work is intentionally separate from CUST-WP-0035 so the engine can
|
||||
stabilize before broad documentation churn.
|
||||
|
||||
## T01: Dashboard lifecycle documentation
|
||||
|
||||
```task
|
||||
id: CUST-WP-0037-T01
|
||||
status: done
|
||||
priority: medium
|
||||
state_hub_task_id: "919d21cb-1cdc-448e-a722-38f1b6374ffb"
|
||||
```
|
||||
|
||||
Review `state-hub/dashboard/src/docs/` and update any page that describes
|
||||
workstream or task lifecycle, status values, contribution flows, or capability
|
||||
request transitions.
|
||||
|
||||
Acceptance: dashboard docs describe workstations and derived blocked state
|
||||
without implying that lifecycle movement is controlled by fixed enum tables.
|
||||
|
||||
## T02: Repo DOI policy wording
|
||||
|
||||
```task
|
||||
id: CUST-WP-0037-T02
|
||||
status: done
|
||||
priority: medium
|
||||
state_hub_task_id: "d6485f6c-815f-4f50-a35e-3fd42046691f"
|
||||
```
|
||||
|
||||
Review `state-hub/policies/repo-doi.md` for task/workstream status checks that
|
||||
assume specific enum values. Update wording to distinguish stored workstation
|
||||
labels from engine-derived health and blocking assertions.
|
||||
|
||||
Acceptance: policy language remains operationally precise while matching the
|
||||
task-flow-engine model.
|
||||
|
||||
## T03: Agent guidance refresh
|
||||
|
||||
```task
|
||||
id: CUST-WP-0037-T03
|
||||
status: done
|
||||
priority: medium
|
||||
state_hub_task_id: "79251442-12a0-4a00-9e3a-fc484933259d"
|
||||
```
|
||||
|
||||
Review `agents/agent-scope-analyst.md` and other active kaizen/custodian agent
|
||||
instructions for status-transition assumptions.
|
||||
|
||||
Acceptance: agents prefer `get_flow_state()` and `advance_workstation()` where
|
||||
flow-aware lifecycle movement is relevant.
|
||||
|
||||
## T04: Session protocol references
|
||||
|
||||
```task
|
||||
id: CUST-WP-0037-T04
|
||||
status: done
|
||||
priority: medium
|
||||
state_hub_task_id: "e2a9d096-b66a-43f2-af87-ec802ba9e795"
|
||||
```
|
||||
|
||||
Review project/global `CLAUDE.md` references that instruct agents to call
|
||||
`update_workstream_status()` or `update_task_status()` for lifecycle movement.
|
||||
|
||||
Acceptance: references point to the flow-aware pattern where appropriate while
|
||||
keeping direct status tools documented for bootstrap or compatibility cases.
|
||||
|
||||
## T05: Memory/data-model references
|
||||
|
||||
```task
|
||||
id: CUST-WP-0037-T05
|
||||
status: done
|
||||
priority: low
|
||||
state_hub_task_id: "2320cd6b-8dc6-4160-9623-4e6425b637e5"
|
||||
```
|
||||
|
||||
Review `memory/MEMORY.md` and nearby state-hub data-model notes for stale enum
|
||||
language.
|
||||
|
||||
Acceptance: memory/reference notes explain the status-to-workstation shift and
|
||||
link back to CUST-WP-0035 or the task-flow-engine spec.
|
||||
Reference in New Issue
Block a user