39 lines
1.2 KiB
Markdown
39 lines
1.2 KiB
Markdown
|
# DOC_REVIEW: fix-install-update-flow
|
||
|
|
|
||
|
|
## Reviewed Documentation
|
||
|
|
|
||
|
|
1. `README.md` -- updated install instructions
|
||
|
|
2. `CHANGELOG.md` -- task 8 entry
|
||
|
|
|
||
|
|
## Findings
|
||
|
|
|
||
|
|
### 1. README.md
|
||
|
|
|
||
|
|
Install instructions updated to show:
|
||
|
|
- `git clone <your-git-url> ~/.automaton` (placeholder instead of hardcoded URL)
|
||
|
|
- `./install.sh <your-git-url>` (URL as argument)
|
||
|
|
- Note about self-improvement loop being created by default
|
||
|
|
- Note about choosing URL carefully
|
||
|
|
|
||
|
|
**Accuracy:** Matches the implementation. The URL is required as `$1`.
|
||
|
|
|
||
|
|
**Verdict:** PASS
|
||
|
|
|
||
|
|
### 2. CHANGELOG.md
|
||
|
|
|
||
|
|
Entry accurately describes all 5 fixes: git URL, venv cwd, Windows venv path, hook copy, version check. Lists all 3 changed scripts and the 15 new tests.
|
||
|
|
|
||
|
|
**Verdict:** PASS
|
||
|
|
|
||
|
|
### 3. Cross-reference check
|
||
|
|
|
||
|
|
- `design/loops/technical.md` section 9 references `install.sh` -- still accurate (the self-improvement loop bootstrap is still there, just the URL handling changed).
|
||
|
|
- `AGENTS.md` references `install.sh` in the repo layout -- no changes needed.
|
||
|
|
- `prompts/onboarding.md` references hook installation -- no changes needed (hooks are installed via `install-hooks.sh`, which is unchanged).
|
||
|
|
|
||
|
|
## Summary
|
||
|
|
|
||
|
|
All documentation is accurate and consistent with the implementation.
|
||
|
|
|
||
|
|
**Verdict: APPROVED**
|