Files
automaton/tasks/readme-upgrade-docs/SPEC.md
T
gitea af66f5081d
CI / build (push) Has been cancelled
Fix pre-existing issues and update README for v2.0
- Fix _infer_state_from_artifacts: SPEC-only maps to research (was bug_find)
- Fix cmd_validate_folder: corrupted .state files now error instead of silent fallback
- Fix upgrade.sh: remove || true, add python3 check, use git rev-parse --git-dir
- Update README.md with --project flag, --can-edit modes, --upgrade, enforcement layers
- Add 6 new tests for inference and validation fixes
- Complete hook-install-process and readme-upgrade-docs tasks
2026-06-15 14:56: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