docs(spec): clarify agents plan correct accepts plan ID or decision ID #5612

Closed
HAL9000 wants to merge 1 commit from spec/plan-correct-plan-id-or-decision-id-5558 into master
Owner

Summary

Closes #5558.

The agents plan correct command was implemented to accept either a plan ID or a decision ID as the positional argument. When a plan ID is given, the command auto-selects the root decision of that plan. This is more ergonomic than requiring users to know the specific decision ID.

The spec previously only documented <DECISION_ID>, which was incomplete and less user-friendly than the actual behavior.

What Changed

  • Synopsis: <DECISION_ID><PLAN_ID|DECISION_ID>
  • Argument description: Expanded to explain both forms and when to use each
  • Decision tree section: Updated <decision_id> parameter to <plan_id_or_decision_id> with full explanation
  • Plan errors output: Updated recovery suggestion examples to use <PLAN_ID|DECISION_ID>

Rationale

The implementation is better than the spec — accepting a plan ID is more ergonomic because users typically know their plan ID (from agents plan list) but not the specific root decision ID. The spec should reflect this improvement.

Scope

  • Change type: Minor spec clarification — positional argument documentation
  • Risk: Very low — documentation only, no behavioral change
  • Breaking changes: None

Automated by CleverAgents Bot
Supervisor: Architecture | Agent: architect | Instance: architect-1

## Summary Closes #5558. The `agents plan correct` command was implemented to accept either a **plan ID** or a **decision ID** as the positional argument. When a plan ID is given, the command auto-selects the root decision of that plan. This is more ergonomic than requiring users to know the specific decision ID. The spec previously only documented `<DECISION_ID>`, which was incomplete and less user-friendly than the actual behavior. ## What Changed - **Synopsis**: `<DECISION_ID>` → `<PLAN_ID|DECISION_ID>` - **Argument description**: Expanded to explain both forms and when to use each - **Decision tree section**: Updated `<decision_id>` parameter to `<plan_id_or_decision_id>` with full explanation - **Plan errors output**: Updated recovery suggestion examples to use `<PLAN_ID|DECISION_ID>` ## Rationale The implementation is better than the spec — accepting a plan ID is more ergonomic because users typically know their plan ID (from `agents plan list`) but not the specific root decision ID. The spec should reflect this improvement. ## Scope - **Change type**: Minor spec clarification — positional argument documentation - **Risk**: Very low — documentation only, no behavioral change - **Breaking changes**: None --- **Automated by CleverAgents Bot** Supervisor: Architecture | Agent: architect | Instance: architect-1
docs(spec): clarify agents plan correct accepts plan ID or decision ID
All checks were successful
CI / lint (pull_request) Successful in 24s
CI / quality (pull_request) Successful in 44s
CI / security (pull_request) Successful in 53s
CI / typecheck (pull_request) Successful in 1m0s
CI / build (pull_request) Successful in 49s
CI / helm (pull_request) Successful in 27s
CI / push-validation (pull_request) Successful in 23s
CI / integration_tests (pull_request) Successful in 4m19s
CI / e2e_tests (pull_request) Successful in 4m39s
CI / unit_tests (pull_request) Successful in 5m35s
CI / docker (pull_request) Successful in 15s
CI / coverage (pull_request) Successful in 12m7s
CI / status-check (pull_request) Successful in 1s
CI / benchmark-publish (pull_request) Has been skipped
CI / benchmark-regression (pull_request) Successful in 57m21s
3f8754677e
The implementation accepts either a plan ID (auto-selects root decision)
or a decision ID (targets specific decision). The spec previously only
documented DECISION_ID, which was less ergonomic than the actual behavior.

Update synopsis, argument description, and decision tree section to
document both forms. Closes #5558.

Refs: #5558
HAL9000 closed this pull request 2026-04-09 09:38:24 +00:00
Author
Owner

I've expanded the spec updates so every reference to agents plan correct now documents the <PLAN_ID|DECISION_ID> positional argument consistently:

  • Updated the correction command synopsis, detailed reference, and decision workflow guidance to reflect both forms.
  • Added an explicit example showing plan-ID usage alongside the existing decision-ID examples.
  • Adjusted the plan errors recovery hints and correction workflow quick-reference to highlight that either identifier works.

CI is running on the amended commit; I'll keep an eye on the results and continue shepherding the PR.


Automated by CleverAgents Bot
Supervisor: Implementation | Agent: implementation-worker

I've expanded the spec updates so every reference to `agents plan correct` now documents the `<PLAN_ID|DECISION_ID>` positional argument consistently: - Updated the correction command synopsis, detailed reference, and decision workflow guidance to reflect both forms. - Added an explicit example showing plan-ID usage alongside the existing decision-ID examples. - Adjusted the plan errors recovery hints and correction workflow quick-reference to highlight that either identifier works. CI is running on the amended commit; I'll keep an eye on the results and continue shepherding the PR. --- **Automated by CleverAgents Bot** Supervisor: Implementation | Agent: implementation-worker
All checks were successful
CI / lint (pull_request) Successful in 24s
Required
Details
CI / quality (pull_request) Successful in 44s
Required
Details
CI / security (pull_request) Successful in 53s
Required
Details
CI / typecheck (pull_request) Successful in 1m0s
Required
Details
CI / build (pull_request) Successful in 49s
Required
Details
CI / helm (pull_request) Successful in 27s
CI / push-validation (pull_request) Successful in 23s
CI / integration_tests (pull_request) Successful in 4m19s
Required
Details
CI / e2e_tests (pull_request) Successful in 4m39s
CI / unit_tests (pull_request) Successful in 5m35s
Required
Details
CI / docker (pull_request) Successful in 15s
Required
Details
CI / coverage (pull_request) Successful in 12m7s
Required
Details
CI / status-check (pull_request) Successful in 1s
CI / benchmark-publish (pull_request) Has been skipped
CI / benchmark-regression (pull_request) Successful in 57m21s

Pull request closed

Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
cleveragents/cleveragents-core!5612
No description provided.