Skip to content

docs: fix stale testing section, broken publishing link, and add agent-team troubleshooting#119

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-contributing-testing-and-agent-team-troubleshooting-b98b8de00af7855f
Draft

docs: fix stale testing section, broken publishing link, and add agent-team troubleshooting#119
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-contributing-testing-and-agent-team-troubleshooting-b98b8de00af7855f

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Triggered by the update-docs workflow after PR #69 merged. Three documentation gaps identified and fixed.

What changed

CONTRIBUTING.md — Testing section rewritten

The section opened with "There is no automated test harness" — factually wrong since tests/ ships a full three-tier suite (Tier 2 invariants, Tier 1 skill tests, Tier 3 E2E). Replaced with accurate quick-start commands and tier descriptions pointing to tests/README.md.

CONTRIBUTING.md — Broken publishing cross-reference

Publishing (maintainers only) linked to README.md#publishing, a section that does not exist. Replaced with an inline description of the maintainer publishing steps (bump plugin.json, create a GitHub Release, submit to external registries).

catalog/agent-team/README.md — Troubleshooting for blocked issues

PR #69 introduced a "fail loud" behavior: when a manual workflow_dispatch runs without required inputs, the agent now posts 🛑 agent-team: workflow_dispatch inputs were not propagated and blocks the issue. The existing "Retrying a blocked task" step only documented label re-add, which is the wrong recovery path for this case (the spec agent immediately exits when a spec already exists).

Expanded step 5 to cover all three recovery paths:

  • Reviewer kickback / human halt → manual gh workflow run with correct -f flags
  • Input-propagation failure → same, with the full -f flag list per role
  • Full restart from scratch → clear state labels + delete spec comment, then re-label

Testing

  • ./tests/test-invariants.sh — all 27 assertions pass (no forbidden phrases introduced, required phrases still present, $\{\{ github.event.inputs.* }} still in catalog/agent-team/README.md)
  • No skill .md files changed — Tier 1 tests unaffected

Generated by Update Docs ·

To install this agentic workflow, run

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

…t-team troubleshooting

CONTRIBUTING.md Testing section claimed "there is no automated test
harness" — factually wrong since tests/ has a full three-tier suite
(invariants, skill tests, E2E). Replaced with accurate description and
quick-start commands pointing to tests/README.md.

Fixed a broken cross-reference: "Publishing section of the README"
linked to README.md#publishing, which does not exist. Replaced with an
inline description of the maintainer publishing steps.

catalog/agent-team/README.md: expanded "Kicking off a task" step 5 to
cover all three recovery paths for a blocked issue — reviewer kickback,
the new "inputs not propagated" fail-loud state introduced in PR #69,
and full-restart from scratch. Previously, only the label-re-add path
was documented, which is the wrong recovery for input-propagation
failures (re-adding the label does nothing when a spec already exists).

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 15, 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