44 lines
2.0 KiB
Markdown
44 lines
2.0 KiB
Markdown
|
# DOC_REVIEW: add-goal-mode
|
||
|
|
|
||
|
|
Reviewed doc impact for task `add-goal-mode`.
|
||
|
|
|
||
|
|
## Doc edits in this task
|
||
|
|
|
||
|
|
### 1. `design/loops/technical.md`
|
||
|
|
Schema section (section 2) already updated with `work_source` and `acceptance_criteria` fields. Self-improvement example (section 9) already references `work_source: {kind: "audit"}`. No further changes needed.
|
||
|
|
|
||
|
|
### 2. `design/loops/functional.md`
|
||
|
|
Already documents `work_source` and `acceptance_criteria` in the loop.json field list (lines 96-97). No change needed.
|
||
|
|
|
||
|
|
### 3. `templates/loops/ci-triage/loop.json`
|
||
|
|
Updated with explicit `"work_source": {"kind": "single"}` and `"acceptance_criteria": [...]`. Matches SPEC R7. No further change.
|
||
|
|
|
||
|
|
### 4. `AGENTS.md`
|
||
|
|
The "State Enforcement -- Loops (v1)" section mentions `--check-gate` and the runner. No new CLI surface in this task (the `--goal` flag is deferred to v1.1 per SPEC Non-Goals). No change needed.
|
||
|
|
|
||
|
|
### 5. `README.md`
|
||
|
|
The loop engineering section already references work sources at a high level. The specific `work_source.kind` values (`single`, `audit`, `backlog`) are implementation details documented in `design/loops/`. No change needed for v1.
|
||
|
|
|
||
|
|
### 6. `CHANGELOG.md`
|
||
|
|
Add an `[unreleased]` entry for goal-mode work sources, verifier tokens, and audit --json. **Action:** apply.
|
||
|
|
|
||
|
|
### 7. `prompts/`
|
||
|
|
No loop prompts land in this task (deferred to task 6 per SPEC Non-Goals). No change.
|
||
|
|
|
||
|
|
### 8. `contracts/harness-integration.md`
|
||
|
|
No new harness integration surface in this task. No change.
|
||
|
|
|
||
|
|
## Code-doc consistency check
|
||
|
|
|
||
|
|
- `technical.md` section 2 schema: `work_source.kind` values match the `_FIND_WORK_DISPATCH` keys (`single`, `audit`, `backlog`). PASS
|
||
|
|
- `technical.md` section 2 schema: `acceptance_criteria` described as "string OR list" matches `_acceptance_criteria_text` implementation. PASS
|
||
|
|
- `functional.md` line 96-97: `work_source` shape matches implementation. PASS
|
||
|
|
- `ci-triage/loop.json`: template fields match schema docs. PASS
|
||
|
|
|
||
|
|
## Summary
|
||
|
|
|
||
|
|
Doc edits in this task:
|
||
|
|
- `CHANGELOG.md`: new `[unreleased]` entry.
|
||
|
|
|
||
|
|
No code-doc mismatches found. READY for referee.
|