diff --git a/docs/work/agent-workflow-docs-v1/01-docs-rewrite/_story.md b/docs/work/agent-workflow-docs-v1/01-docs-rewrite/_story.md new file mode 100644 index 0000000..8b3c3d3 --- /dev/null +++ b/docs/work/agent-workflow-docs-v1/01-docs-rewrite/_story.md @@ -0,0 +1,42 @@ +--- +id: 01-docs-rewrite +epic: agent-workflow-docs-v1 +title: Surface conformance system across top-level docs +type: technical-story +status: in-progress +feature: docs +depends-on: [] +blocks: [] +--- + +## Goal +Update CLAUDE.md, AGENTS.md, and four guides so agents picking up this +repo discover and follow the manifest-first workflow by default. + +## Done when +- CLAUDE.md has a "Conformance system" section + manifest-first ordering + added to Key Conventions +- AGENTS.md's per-feature conventions mention the manifest contract +- adding-a-feature.md updated to the 4-step ordering +- scaffolding-a-feature.md notes the manifest emission + boot assertion +- tdd-workflow.md links to the conformance enforcement +- New conformance-quickref.md exists as a single-page agent reference + +## In scope +Mechanical doc updates pointing at existing artifacts (the design doc, the +feature-conformance-explainer.html, the actual rules / wrappers / script +already merged). + +## Out of scope +- Rewriting the existing architecture docs (already in place) +- Updating per-package AGENTS.md inside packages/* + +## Tasks +- [ ] Epic + story scaffold +- [ ] CLAUDE.md update +- [ ] AGENTS.md update +- [ ] adding-a-feature.md update +- [ ] scaffolding-a-feature.md update +- [ ] tdd-workflow.md update +- [ ] conformance-quickref.md (new) +- [ ] Final verification + closeout diff --git a/docs/work/agent-workflow-docs-v1/_epic.md b/docs/work/agent-workflow-docs-v1/_epic.md new file mode 100644 index 0000000..5f4a45f --- /dev/null +++ b/docs/work/agent-workflow-docs-v1/_epic.md @@ -0,0 +1,36 @@ +--- +id: agent-workflow-docs-v1 +prd: null +title: Agent-workflow docs rollout +type: epic +status: in-progress +features: [docs] +created: 2026-05-13 +--- + +## Goal +Surface the conformance-system-v1 mechanics across CLAUDE.md, AGENTS.md, +and the feature-development guides so agents picking up this codebase +follow the manifest-first workflow by default. + +## Why +The conformance system is the substrate, but agents read the top-level +docs first. Until the docs say "feature.manifest.ts exists, here's what +it does, here's how the gates fire," the system stays invisible to +agents iterating on this repo for the first time. + +## In scope +- CLAUDE.md: add conformance system section + manifest-first ordering +- AGENTS.md: add manifest convention to per-package conventions +- docs/guides/adding-a-feature.md: update workflow to manifest → contracts → tests → code +- docs/guides/scaffolding-a-feature.md: note that generator now emits manifest + boot assertion +- docs/guides/tdd-workflow.md: link conformance system as the enforcement layer +- New docs/guides/conformance-quickref.md: ~80-line agent-facing reference + +## Out of scope +- Frontend-conformance docs (next epic) +- Work-system-v1 docs (those land with the work-system epic) +- Editing the original conformance design docs (already in place) + +## Stories +- [ ] [01 — Surface conformance system across CLAUDE.md / AGENTS.md / guides](01-docs-rewrite/_story.md)