🧹 Project TODOs & Improvements (Meta Issue)

[shalev007]

This issue is a running list of small/medium improvements, cleanup tasks, and dev experience ideas that should be tracked but don't yet deserve their own issue. Feel free to break these out into separate issues or PRs as needed.

---

✅ Checkpointing & Execution Model

• Move the incremental checkpoint hash into the checkpoint metadata (instead of using it as the filename)
• Add a validate() function to the abstract Checkpoint class
• Add an initial state option for stored variables (store.var), useful for clean runs or default values
• Detach observers from playbook runtime (optional)

---

🧪 Testing & Validation

• Add a basic test suite (none exists yet) covering core features: phases, retries, sessions, etc.
• Set up testing scaffold (e.g., pytest, coverage, tox, or nox)
• Add CI config for automated test runs (e.g., GitHub Actions)

---

📖 Documentation

• Add a section in the README explaining what prompt to give an LLM (like ChatGPT) to auto-generate a playbook
• Add a CONTRIBUTING.md to help first-time contributors
• Improve overall docs (structure feels lacking—unclear what's missing, but could use better onboarding)
• Add CLI command reference to the docs, either as a dedicated page or CLI-generated dump
• Ensure docs include all supported CLI features/flags (especially new ones like --cron or --dry-run)

---

🧠 Developer Experience

• Add an --interactive flag to more CLI commands (like init, auth, or validate)
• Move circuit_breaker config outside retry block for clarity and flexibility

---

📎 Notes

This issue is for tracking purposes. When any of these are implemented, feel free to:

• Check it off
• Link to the PR
• Create a focused issue for discussion if it grows beyond a quick fix