docs(work): scaffold docs-and-runbook-v1 epic + stories

This commit is contained in:
2026-05-13 09:03:15 +02:00
parent e87e554a7c
commit cf8d69106e
4 changed files with 97 additions and 3 deletions

View File

@@ -1,5 +1,5 @@
{
"updated_at": "2026-05-13T06:55:52.068Z",
"updated_at": "2026-05-13T07:03:16.899Z",
"epics": {
"agent-workflow-docs-v1": {
"status": "done",
@@ -165,6 +165,32 @@
}
}
},
"docs-and-runbook-v1": {
"status": "in-progress",
"title": "Developer runbook + post-Fallow doc sweep",
"stories": {
"01-runbook": {
"status": "in-progress",
"title": "docs/guides/runbook.md — day-1 onboarding",
"ac_total": 2,
"ac_completed": 0,
"depends_on": [],
"blocks": [
"02-doc-sweep"
]
},
"02-doc-sweep": {
"status": "todo",
"title": "README + CLAUDE.md + .env.example sweep",
"ac_total": 5,
"ac_completed": 0,
"depends_on": [
"01-runbook"
],
"blocks": []
}
}
},
"elicitation-prompts-v1": {
"status": "done",
"title": "Elicitation + dispatch prompt templates",
@@ -409,6 +435,21 @@
}
}
},
"ready": [],
"blocked": []
"ready": [
{
"epic": "docs-and-runbook-v1",
"story": "01-runbook",
"title": "docs/guides/runbook.md — day-1 onboarding"
}
],
"blocked": [
{
"epic": "docs-and-runbook-v1",
"story": "02-doc-sweep",
"title": "README + CLAUDE.md + .env.example sweep",
"waiting_on": [
"docs-and-runbook-v1/01-runbook"
]
}
]
}

View File

@@ -0,0 +1,15 @@
---
id: 01-runbook
epic: docs-and-runbook-v1
title: docs/guides/runbook.md — day-1 onboarding
type: technical-story
status: in-progress
feature: docs
depends-on: []
blocks: [02-doc-sweep]
---
## Tasks
- [ ] Story scaffold
- [ ] Write docs/guides/runbook.md (sections: Prerequisites, First-time setup, Daily commands, Env vars, Agent-first workflow, Conformance gates reference, Troubleshooting, Where to read next)

View File

@@ -0,0 +1,18 @@
---
id: 02-doc-sweep
epic: docs-and-runbook-v1
title: README + CLAUDE.md + .env.example sweep
type: technical-story
status: todo
feature: docs
depends-on: [01-runbook]
blocks: []
---
## Tasks
- [ ] Update README.md to point at runbook + reflect 5 gates
- [ ] Expand .env.example to cover all relevant env vars with comments
- [ ] Sweep CLAUDE.md "Quick Start" for new commands (pnpm work, pnpm fallow, pnpm fallow:audit)
- [ ] Add a "Conformance gates" reference line to docs/guides/conformance-quickref.md noting Fallow is the 5th
- [ ] Final verification + closeout

View File

@@ -0,0 +1,20 @@
---
id: docs-and-runbook-v1
prd: null
title: Developer runbook + post-Fallow doc sweep
type: epic
status: in-progress
features: [docs]
created: 2026-05-13
---
## Goal
Write the day-1 developer runbook + sweep top-level docs for staleness
against the now-shipped conformance-system, work-system, sandcastle,
and Fallow integration.
## Stories
- [ ] [01 — Developer runbook](01-runbook/_story.md)
- [ ] [02 — Doc sweep + .env.example expansion](02-doc-sweep/_story.md)