57 lines
2.2 KiB
Markdown
57 lines
2.2 KiB
Markdown
|
# DOC_REVIEW: add-loop-templates-onboarding
|
||
|
|
|
||
|
|
## Reviewed Documentation
|
||
|
|
|
||
|
|
1. `README.md` -- new "Loop Engineering" onboarding section (Quick Start, Tick Cycle, Configuration, Monitoring, Halt/Resume)
|
||
|
|
2. `CHANGELOG.md` -- task 6 entry under `[unreleased]`
|
||
|
|
3. `design/loops/technical.md` section 8 -- prompt resolution and token substitution documentation
|
||
|
|
4. `AGENTS.md` -- no changes needed (already documents loop runner and status.py commands)
|
||
|
|
|
||
|
|
## Findings
|
||
|
|
|
||
|
|
### 1. README.md onboarding section
|
||
|
|
|
||
|
|
The new section adds:
|
||
|
|
- Quick Start with 3 commands (create, install-schedule, monitor)
|
||
|
|
- Tick Cycle diagram (11-step flow summary)
|
||
|
|
- Configuration table with all `loop.json` fields
|
||
|
|
- Monitoring commands
|
||
|
|
- Halt/Resume commands
|
||
|
|
|
||
|
|
**Accuracy:** All commands and field names match the actual implementation. The configuration table correctly documents `use_worktree` (not `worktree`), `work_source.kind` values (`single`, `audit`, `backlog`), and the role prompt fields.
|
||
|
|
|
||
|
|
**Completeness:** Covers all R7 sub-requirements from the SPEC.
|
||
|
|
|
||
|
|
**Verdict:** PASS
|
||
|
|
|
||
|
|
### 2. CHANGELOG.md
|
||
|
|
|
||
|
|
Entry accurately describes all changes: `_resolve_prompt`, `_invoke_harness` extension, new prompt files, template updates, new self-improvement template, README section, technical.md section 8, new tests (18), test infrastructure updates.
|
||
|
|
|
||
|
|
**Verdict:** PASS
|
||
|
|
|
||
|
|
### 3. design/loops/technical.md section 8
|
||
|
|
|
||
|
|
New "Prompt Resolution and Token Substitution" subsection documents:
|
||
|
|
- File search order (loop-local then framework)
|
||
|
|
- Content-level token substitution
|
||
|
|
- `{artifact_content}` special handling
|
||
|
|
- Temp file write and return path
|
||
|
|
- Loop-local override capability
|
||
|
|
|
||
|
|
**Accuracy:** Matches the implementation in `_resolve_prompt`.
|
||
|
|
|
||
|
|
**Verdict:** PASS
|
||
|
|
|
||
|
|
### 4. Cross-reference check
|
||
|
|
|
||
|
|
- `AGENTS.md` "Loop runner" bullet references `design/loops/technical.md` §7 for the tick flow -- still accurate.
|
||
|
|
- `config.md` mentions role-to-prompt binding in `loop.json` -- still accurate.
|
||
|
|
- `prompts/` directory now has 3 new files (`loop-implement.md`, `loop-verifier.md`, `loop-orchestrate.md`) -- not listed in any index (there is no prompts/ index file), so no update needed.
|
||
|
|
|
||
|
|
## Summary
|
||
|
|
|
||
|
|
All documentation is accurate, complete, and consistent with the implementation. No doc gaps found.
|
||
|
|
|
||
|
|
**Verdict: APPROVED**
|