40 lines
2.1 KiB
Markdown
40 lines
2.1 KiB
Markdown
|
# DOC_REVIEW: add-loop-runner
|
||
|
|
|
||
|
|
Reviewed doc impact for task `add-loop-runner`.
|
||
|
|
|
||
|
|
## Doc edits in this task
|
||
|
|
|
||
|
|
### 1. `AGENTS.md` Build & Test Commands
|
||
|
|
Add `python3 scripts/loop-runner.py --mode tick --loop <name>` to the install/run section so harnesses know how to fire a tick. Also add a note under "State Enforcement — Loops (v1)" that the runner is the runtime partner of the brakes layer.
|
||
|
|
|
||
|
|
**Action:** apply small AGENTS.md update.
|
||
|
|
|
||
|
|
### 2. `README.md`
|
||
|
|
The "Loop Engineering (beta)" section already mentions the runner's CLI shape (`--create-loop`, `--install-schedule`, etc). It should add a one-liner that the actual per-tick engine is `loop-runner.py`. **Action:** add one line.
|
||
|
|
|
||
|
|
### 3. `CHANGELOG.md`
|
||
|
|
Add an `[unreleased]` entry for the runner. **Action:** apply.
|
||
|
|
|
||
|
|
### 4. `design/loops/technical.md` §8 (Harness Invocation)
|
||
|
|
Already documents the `harness.command` shape and the default `opencode run`. Matches the implementation. **No change.**
|
||
|
|
|
||
|
|
### 5. `prompts/`
|
||
|
|
No loop prompts land in this task (deferred to task 6). **No change.**
|
||
|
|
|
||
|
|
### 6. `config.md`
|
||
|
|
The runner reads `loop_mode_eligible` from `vram_detect.py --loop-mode --json`, which task 1 already exposes. No new config field. **No change.**
|
||
|
|
|
||
|
|
### 7. `templates/loops/ci-triage/loop.json`
|
||
|
|
Currently has `roles: {implement: null, verify: null, orchestrate: null}`. The runner tolerates nulls (calls `_invoke_harness` with empty prompt path). For a usable ci-triage template, the prompts should be filled in task 6. For task 3, the template remains the minimal stub. **No change in task 3.**
|
||
|
|
|
||
|
|
### 8. `contracts/harness-integration.md`
|
||
|
|
Should mention `loop-runner.py --check-gate` for harnesses that want to integrate loop awareness. But touching the contract doc is out of scope per the task-2 doc-review precedent; defer to a follow-on doc-rev task. **Defer.**
|
||
|
|
|
||
|
|
## Summary
|
||
|
|
|
||
|
|
Doc edits in this task:
|
||
|
|
- `AGENTS.md`: 1 paragraph under "State Enforcement — Loops (v1)" referencing `loop-runner.py`.
|
||
|
|
- `README.md`: 1 sentence in the loop section.
|
||
|
|
- `CHANGELOG.md`: new `[unreleased]` entry.
|
||
|
|
|
||
|
|
No code-doc mismatches found. READY for referee.
|