Files
automaton/tasks/complete/add-status-brakes/DOC_REVIEW.md
T
Lap Tran 4a2301b077
CI / build (push) Has been cancelled
Archive completed tasks, add cleanup commands, self-documenting dashboard UI
- Archive 79 completed framework-dev tasks from tasks/ -> tasks/complete/
- status.py: add --cleanup-done and --install-cleanup-schedule commands
- Add scripts/automaton-cleanup.sh for periodic task archiving
- Dashboard: rename 'Background' tab -> 'Agent', 'Cleanup' agent -> 'Completed Task Archiver', remove redundant group headers and pill badges, dim inactive agent placeholders
- .rules.md: add Self-Documenting UI Names rule
- New tests: test_cleanup_done.py, expanded test_app.py and test_task.py
2026-06-24 22:43:33 -04:00

2.7 KiB
Raw Blame History

Doc Review: add-status-brakes

Reviewed doc impact: AGENTS.md, README.md, prompts/, config.md, CHANGELOG.md.

Doc gaps to land in THIS task

Already updated in this task

  • None ( изменения are in status.py, tests/test_status_brakes.py, templates/loops/ci-triage/loop.json). No prompt or config doc touched.

To be updated (within this task's scope or follow-on)

  1. AGENTS.md Build & Test Commands section — should mention:

    • python3 -m pytest tests/test_status_brakes.py -v
    • --version flag exists

    However, AGENTS.md is a framework-wide doc; per the project convention it covers the test suite as a whole, not per-test-file. Decision: do NOT pile per-test-file entries into AGENTS.md — the existing python3 -m pytest tests/ -v already covers it. Leave alone.

  2. AGENTS.md Harness Integration section — should add the new --can-edit --loop [--loop-worktree] --file P mode. The current AGENTS.md describes modes 1–4 for --can-edit. Adding a 5th mode belongs here.

    Action: extend AGENTS.md's "Modes:" block under Harness Integration to describe the loop worktree scope mode. Will apply in this task.

  3. AGENTS.md Conventions / State Enforcement section — should mention .state.loop and --approve --loop. Will add a short paragraph.

  4. README.md — user-facing. Should mention loop commands exist (high-level). Defer detailed user docs to task 6 (templates/onboarding); only the existence of loop commands is in scope here.

    Action: add a brief "Loop engineering (beta)" subsection in README.md.)

  5. prompts/ — no loop-specific prompts land in this task. Task 6 owns prompts/loop-{implement,verifier,orchestrate}.md. No action.

  6. config.md — already has ## Loop Role Models (task 1) and ## Framework Version. The ## Framework Version section is what --version parses. Confirmed it parses correctly. No action.

  7. CHANGELOG.md — should get an [unreleased] entry for the brakes layer. Action: add.

Doc consistency observations (non-blocking, defer)

  • The harness-integration contract at contracts/harness-integration.md lists --can-edit modes 1–4. Should add mode 5 (--loop worktree). Defer to a follow-on doc-rev task; touching the contract file is out of scope for this code task and risks destabilizing the contract.
  • design/loops/technical.md describes --install-schedule semantics; the implementation matches. No update needed.

Summary of doc edits in this task

  • AGENTS.md: extend Harness Integration modes list; brief .state.loop paragraph.
  • README.md: one "Loop engineering (beta)" subsection.
  • CHANGELOG.md: entry under [unreleased].

No code-doc mismatches found. READY for referee.