state-hub/docs/workplan-convention.md
tegwick 9693946755
All checks were successful
CI Smoke / host-smoke (push) Successful in 0s
CI Smoke / container-smoke (push) Successful in 2s
feat(consistency): coordination hygiene checks and MCP workplan_id aliases
Add C-25..C-30 fix-consistency checks for blocked-workplan inbox sweeps,
stale unread triage, workplan ID prefix/collision lint, and SCOPE freshness.
Extend brief generation and get_domain_summary with inbox hygiene warnings.
Complete workplan_id aliases on remaining MCP tools and retry transient
_api_get failures to reduce false stale-reference errors under load.
2026-07-08 00:56:21 +02:00

1.2 KiB

State Hub Workplan Convention

New workplans in this repository use:

STATE-WP-0001-short-title.md

Workplan frontmatter should include:

id: STATE-WP-0001
type: workplan
title: "Short Title"
domain: custodian
repo: state-hub
status: proposed
owner: custodian
topic_slug: custodian

During extraction, legacy CUST-WP-* plans may be bridged or migrated with their existing state_hub_workstream_id values. Write files first, then run State Hub consistency sync after this repo is registered.

When a workplan is blocked, record the unblock condition in frontmatter:

status: blocked
blocked_on: message-from:llm-connect

blocked_on uses the message-from:<agent> form so fix-consistency can cross-check unread inbox messages from that counterpart and warn when the blocker may have cleared.

Canonical workplan/workstream statuses are:

proposed, ready, active, blocked, backlog, finished, archived

Use proposed for a new plan that still needs review, ready after it has been checked against the current repo state, and finished when implementation is complete. stalled and needs_review are derived health labels, not stored frontmatter statuses.