gitea
05c76852a2
CI / build (push) Has been cancelled
State Enforcement (v2.0):
- .state file as single source of truth for task phase
- Approval gates for research, decomposition, design, test_design
- status.py --transition refuses illegal phase transitions
- status.py --validate-folder detects out-of-order artifacts
- status.py --audit checks all tasks for violations
- status.py --create-task is the only valid way to create tasks
- Pre-v2.0 tasks without .state are UNTRACKED -- all commands refuse them
- New --upgrade command bootstraps .state files for existing tasks
Project Scoping:
- --project flag added to all status.py commands across 16+ files
- _find_project_dir errors instead of silently falling back to ~/.automaton/
- --scope-check marks framework files OUT_OF_SCOPE when working on a project
- Dashboard handlers use stored project_root instead of re-detecting from CWD
- Prompts reference ~/.automaton/scripts/vram_detect.py (not {project}/.automaton/)
Harness Integration:
- status.py --can-edit now supports project-level checks (no --task required)
- --can-edit --file checks file scope without --task
- --json output for machine-readable harness integration
- opencode plugin (plugins/automaton-guard/plugin.ts) intercepts edit/write
- Git pre-commit hook (scripts/git-hooks/pre-commit) blocks commits without task
- Formal integration contract (contracts/harness-integration.md)
Other:
- upgrade.sh delegates to status.py --upgrade instead of manual heuristics
- Phase prompts reference --project {project} for multi-project scoping
- 200 tests passing (14 new)
24 lines
1.4 KiB
Markdown
24 lines
1.4 KiB
Markdown
# Documentation Review: task-status-reason
|
|
|
|
## Summary
|
|
No DESIGN.md. Conducting ad-hoc review of code documentation for the status_reason feature.
|
|
|
|
## Documentation Completeness
|
|
- Code documentation: Adequate — `status_reason` property has a docstring. `parse_verdict_status` was already documented. No DESIGN.md or deployment docs produced (proportional to the small change set).
|
|
- User documentation: Not updated — the dashboard README (`automaton/dashboard/README.md`) doesn't mention the status reason display. The new status_reason field in the API response is also undocumented.
|
|
- API documentation: No formal API docs exist for the dashboard endpoints.
|
|
|
|
## Issues Found
|
|
|
|
### Issue 1: Dashboard README not updated for status reason display
|
|
- **Severity**: Low
|
|
- **Description**: The dashboard README at `automaton/dashboard/README.md` doesn't document that the detail panel now shows a status reason. This is a user-facing UI change without documentation.
|
|
- **Suggested Fix**: Add a note to the README under "Detail Panel" section describing the status reason.
|
|
|
|
### Issue 2: CHANGELOG entry missing bug fixes
|
|
- **Severity**: Low
|
|
- **Description**: The CHANGELOG correctly lists the status_reason feature and revoke buttons, but doesn't mention the REFEREE state fix (a consequence of Bug 2 fix from BUG_REPORT.md).
|
|
- **Suggested Fix**: Add a Fixed entry for the REFEREE state being unreachable.
|
|
|
|
## Score
|
|
+3 |