Files
automaton/tasks/complete/readme-upgrade-docs/SPEC.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

1.1 KiB

README and Upgrade Documentation Update

Goal

Update README.md with complete, clear documentation for v2.0 features: --project flag, --upgrade, --can-edit project-level mode, pre-commit hook installation, and the full upgrade process for existing projects.

Requirements

  • Quick Reference includes --project on every command
  • --can-edit project-level modes documented with examples
  • --upgrade documented for untracked tasks
  • Enforcement layers section (pre-edit hook, pre-commit hook, prompt rules)
  • Upgrade process for existing projects (step-by-step for newcomers)
  • Pre-commit hook installation instructions in Project Setup and Upgrading sections
  • Key Components updated with new files

Acceptance Criteria

  • All status.py examples include --project
  • --can-edit modes documented
  • --upgrade for untracked tasks documented
  • Three enforcement layers documented
  • Upgrade process for existing projects is step-by-step
  • Pre-commit hook installation in both Project Setup and Upgrading
  • Key Components updated
  • 200 tests pass