Skip to content

Commit 480da82

Browse files
authored
docs: rewrite README with problem statement, persona sections, and flow command overview (#136)
1 parent 42ee037 commit 480da82

1 file changed

Lines changed: 40 additions & 6 deletions

File tree

README.md

Lines changed: 40 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,51 @@
1111
[![MIT License][license-shield]][license-url]
1212
[![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen?style=for-the-badge)](https://nullhack.github.io/temple8/coverage/)
1313
[![CI](https://img.shields.io/github/actions/workflow/status/nullhack/temple8/ci.yml?style=for-the-badge&label=CI)](https://github.com/nullhack/temple8/actions/workflows/ci.yml)
14-
[![Python](https://img.shields.io/badge/python-3.13-blue?style=for-the-badge)](https://www.python.org/downloads/)
14+
[![Python](https://img.shields.io/badge/python-%E2%89%A513-blue?style=for-the-badge)](https://www.python.org/downloads/)
1515

1616
**From zero to hero — production-ready Python, without the ceremony.**
1717

1818
</div>
1919

2020
---
2121

22-
A delivery system that treats documentation as a first-class artifact and enforces production rigor through an AI-assisted workflow. Your team ships features, not broken promises.
22+
You have tried to ship features with AI assistants. The agent writes code, you review it, and somehow the spec still drifts from the implementation. Tests pass but the feature doesn't match what stakeholders asked for. Architecture decisions vanish into commit messages nobody reads. The review cycle is a black box — either everything passes or nothing does, with no structured progression.
2323

24-
Developers get TDD by default with traceability from requirement to test. Product Owners get living documentation that never drifts from code. Architects get adversarial review that catches what automated checks miss.
24+
**temple8 replaces ad-hoc agent orchestration with state machines that route every step through the right agent with the right skills at the right time.**
25+
26+
Flow definitions in YAML declare what happens at each state: who owns it, what they may read, what they must produce, and which conditions gate the next transition. No agent guesses what to do next. No step is skipped. No artifact is written outside its contract.
27+
28+
---
29+
30+
## Who is this for?
31+
32+
### Developers — TDD with traceability, not just coverage
33+
34+
You write BDD scenarios from stakeholder interviews. Tests are linked to feature specs with `@id` tags. Every `Given/When/Then` maps to a test function. No orphan tests, no missing tests. Red-green-refactor cycles are enforced — you can't skip to implementation.
35+
36+
### Product Owners — Living documentation that never drifts
37+
38+
Feature files are the contract. Acceptance criteria are BDD scenarios, not bullet points in a ticket. The delivery flow tracks whether a feature is `BASELINED`, `ACCEPTED`, or rejected — with evidence at every gate. You see exactly what was built and why.
39+
40+
### Architects — Adversarial review that catches what linters miss
41+
42+
Three-tier review: design alignment (does it match the domain model?), structure (coverage, traceability, coupling), conventions (formatting, naming, lint). Each tier can fail independently. No rubber-stamping through one monolithic gate.
43+
44+
---
45+
46+
## What it does
47+
48+
```
49+
flowr check → inspect a state's owner, skills, and transitions
50+
flowr next → see which transitions pass given your evidence
51+
flowr transition → advance to the next state with evidence
52+
```
53+
54+
**State machines route the work.** YAML flows define the delivery pipeline — discovery, architecture, planning, TDD cycles, review gates, delivery. Each state declares an owner, skills, input/output artifacts, and guard conditions. The engine validates transitions. The agent executes.
55+
56+
**Agents execute it.** Each state's `owner` dispatches to the right agent (PO, SE, SA, DE, R). Skills are loaded per state. Input/output contracts prevent scope creep. Evidence gates prevent premature transitions.
57+
58+
**Branch discipline is explicit.** Every state declares `git: main` or `git: feature`. Project-phase work commits to main. Feature work commits to a feature branch. No ambiguity about where changes belong.
2559

2660
---
2761

@@ -53,9 +87,9 @@ uv run task doc-build # build API docs + coverage report
5387

5488
## Documentation
5589

56-
- **[Product Definition](docs/product-definition.md)** — product boundaries, users, and scope
57-
- **[System Overview](docs/system.md)** — architecture, domain model, module structure, and constraints
58-
- **[Glossary](docs/glossary.md)** — living domain glossary
90+
- **[Product Definition](https://nullhack.github.io/temple8/)** — product boundaries, users, and scope
91+
- **[System Overview](https://nullhack.github.io/temple8/)** — architecture, domain model, module structure, and constraints
92+
- **[Glossary](https://nullhack.github.io/temple8/)** — living domain glossary
5993

6094
---
6195

0 commit comments

Comments
 (0)