Ty
9b181a937b
The file restated facts owned by other docs and carried personal references. - Drop the status section, the agent-context block, the M3 scope prose, and the 14-bullet invariants list; each restated docs/README.md, docs/MILESTONES.md, or a docs/REQUIREMENTS.md row. - Replace the ports and hosts paragraph with a pointer to docs/DEPLOYMENT.md and deploy/INVENTORY.md. - Correct the subagent rule to the real constraint: one at a time on the single GPU. Subagents do coding work. - Remove the name references. - Keep the structure contract, the change-a-requirement procedure, and the gate commands.
36 lines
1.4 KiB
Markdown
36 lines
1.4 KiB
Markdown
# AGENTS.md
|
|
|
|
`docs/REQUIREMENTS.md` is the only normative text. All other docs cite IDs; none define requirements.
|
|
|
|
## Structure contract (read before creating or moving any doc)
|
|
|
|
- Requirements live only in `docs/REQUIREMENTS.md`; milestone scope in `docs/MILESTONES.md`.
|
|
- Before creating or moving any doc under `docs/`, look up its home in `docs/STRUCTURE.md`.
|
|
- If no home exists, stop — do not create a new artifact.
|
|
- To change a requirement: edit the single row in `REQUIREMENTS.md`; update `Test`; if scope changed, update `MILESTONES.md`. Do not create a doc.
|
|
- Run `python tools/check_requirements.py` after any docs change; it must pass.
|
|
|
|
## Agent runtime rules
|
|
|
|
- Subagents run on one local GPU and cannot handle concurrency. Invoke one at a time; never in parallel.
|
|
|
|
## Gates (must pass before claiming work complete)
|
|
|
|
Run from repo root:
|
|
|
|
```
|
|
python tools/check_requirements.py
|
|
python tools/check_coverage.py
|
|
```
|
|
|
|
Exit 0 on both = pass.
|
|
|
|
## Pointers (read these for everything else)
|
|
|
|
- Docs map and shipped status: `docs/README.md`
|
|
- Scope and ID subsets: `docs/MILESTONES.md`
|
|
- M3 behavior: `docs/capabilities/CREATE.md`
|
|
- Hosts, ports, UAT environment: `docs/DEPLOYMENT.md` and `deploy/INVENTORY.md`
|
|
- Task ordering for M3: `.planning/milestones/v0.5/M3/task_breakdown.md`
|
|
- Product invariants and acceptance criteria: the requirement rows in `docs/REQUIREMENTS.md` (cite by ID)
|