Skip to content

docs(agent-team): add manual dispatch examples and clarify input validation failure behavior#121

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/agent-team-manual-dispatch-examples-2155a0720a32d95e
Draft

docs(agent-team): add manual dispatch examples and clarify input validation failure behavior#121
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/agent-team-manual-dispatch-examples-2155a0720a32d95e

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

What changed

Updates catalog/agent-team/README.md to surface two documentation gaps exposed by d688265 — the commit that hardened workflow_dispatch input validation across all three dispatched agents.

Gap 1 — Manual dispatch had no example commands

"Kicking off a task" step 4 previously told users:

manually gh workflow run a specific role to retry a stuck stage. Manual dispatches must pass the required workflow_dispatch inputs...

...but gave no actual commands. Now that missing inputs fail loudly with state:blocked, this gap is a usability hazard: users who omit an input will get a blocked issue with no hint of what went wrong.

Fix: replaced the generic sentence with concrete gh workflow run examples for each dispatched workflow, covering:

  • planner re-dispatch
  • implementer first attempt (no pr_number)
  • implementer kickback retry (with existing pr_number)
  • reviewer re-dispatch

Gap 2 — "Input propagation" gotcha was underspecified

The "Limits and gotchas" bullet previously said agents "must fail loudly" but didn't say what that means in practice.

Fix: described the actual behavior — state:blocked added to the issue + a specific error comment posted, or report_incomplete called when issue_number itself is absent.

Files changed

  • catalog/agent-team/README.md — 19 lines added, 2 lines replaced

Test plan

  • Render the markdown and confirm the code block in step 4 displays correctly
  • Verify the gh workflow run commands match the workflow_dispatch.inputs declared in each agent's frontmatter (planner-agent.md, implementer-agent.md, reviewer-agent.md)
  • Confirm no links are broken in the updated file

🤖 Generated with [Claude Code]((claude.ai/redacted)

Generated by Update Docs ·

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/update-docs.md@96b9d4c39aa22359c0b38265927eadb31dcf4e2a

…dation behavior

Prompted by d688265 which hardened workflow_dispatch input validation across
all three dispatched agents (planner, implementer, reviewer). The README told
users to manually `gh workflow run` a specific role to retry a stuck stage but
gave no example commands — now that missing inputs fail loudly with state:blocked,
this gap is a usability hazard.

Changes:
- Step 4 of "Kicking off a task": replace the generic mention of manual dispatch
  with concrete `gh workflow run` examples for each dispatched workflow,
  covering first-attempt and kickback-retry cases for the implementer.
- "Limits and gotchas" → Input propagation bullet: describe the actual failure
  behavior (state:blocked + error comment, or report_incomplete if issue_number
  is absent) instead of just saying "fail loudly".

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels May 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants