docs(work): scaffold agent-workflow-docs-v1 epic + story 01
This commit is contained in:
36
docs/work/agent-workflow-docs-v1/_epic.md
Normal file
36
docs/work/agent-workflow-docs-v1/_epic.md
Normal file
@@ -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)
|
||||
Reference in New Issue
Block a user