Repository navigation
docs: describe runbook parameters as bounded named strings - #43
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
🟡 Changes recommended
The release-facing CHANGELOG.md still describes version 0.9.0 as having “typed parameters,” leaving the superseded contract documented despite the terminology correction in README.md.
1 open issue
What changed in this PR
This documentation-only pull request corrects runbook parameter terminology to reflect the 0.9 contract: parameters are named strings constrained by patterns, length limits, and optional allowlists. No runtime behavior or release metadata changes are included.
Changes:
- Updated README, roadmap, and feature documentation.
- Updated the runbook models module docstring.
- Preserved existing validation behavior.
| File | Summary |
|---|---|
src/agenticops_control_tower/runbooks/models.py |
Corrects the module documentation to describe bounded string parameters. |
README.md |
Updates the 0.9 overview terminology. Review note: the historical CHANGELOG.md entry still uses “typed parameters.” |
docs/roadmap.md |
Aligns the 0.9 roadmap description with the actual parameter contract. |
docs/features.md |
Corrects the feature documentation terminology. |
Review effort: Lite
| reusable recovery workflows. Each definition declares prerequisites, named | ||
| string parameters and ordered steps with per-step timeouts, clean-failure retry limits |
Follow-up to #42. A sibling review pointed out that "typed parameters" overstates the 0.9 contract: runbook parameters are named strings, each constrained by a pattern, a length limit and an optional allowed list. This corrects the wording in docs/features.md, docs/roadmap.md and the models module docstring. No behavior change and no release.