Skip to content

docs: fix test harness claim, broken publishing link, and add manual dispatch examples#115

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-contributing-and-dispatch-examples-b027b75bf91d42f7
Draft

docs: fix test harness claim, broken publishing link, and add manual dispatch examples#115
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-contributing-and-dispatch-examples-b027b75bf91d42f7

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Three documentation fixes identified during a post-#69 documentation audit.

Changes

CONTRIBUTING.md — testing section rewritten

The previous text stated "There is no automated test harness for skills" — factually incorrect. The repo has a full multi-tier test suite (tests/run-tests.sh, tier-1 skill tests, tier-2 invariants, tier-3 e2e). Replaced with an accurate summary table and the correct run commands, matching tests/README.md.

CONTRIBUTING.md — broken publishing link removed

## Publishing (maintainers only) pointed to README.md#publishing, an anchor that does not exist in README.md. Replaced the dead link with the inline publishing steps (bump version in both plugin manifest files, cut a GitHub release, notify the two registries).

catalog/agent-team/README.md — concrete manual dispatch examples added

PR #69 hardened the agents to fail loudly when workflow_dispatch inputs are missing. The Kicking off a task section already mentioned manual dispatch as a recovery option but didn't show the exact gh workflow run commands. Added explicit examples for all four roles (planner, implementer first-pass, implementer kickback with pr_number, reviewer) and a one-liner explaining the 🛑 workflow_dispatch inputs were not propagated error message.

Test plan

  • Read-through: verify the rewritten testing section in CONTRIBUTING.md matches tests/README.md
  • Read-through: verify the publishing steps in CONTRIBUTING.md match .claude-plugin/plugin.json + marketplace.json version fields
  • Read-through: verify the gh workflow run examples in catalog/agent-team/README.md match the workflow_dispatch.inputs blocks in each agent .md 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

…patch examples

- CONTRIBUTING.md: replace false "no automated test harness" claim with
  accurate description of the tier-1/2/3 test suite (tests/README.md)
- CONTRIBUTING.md: replace broken README.md#publishing link with inline
  publishing steps (no such anchor existed in README.md)
- catalog/agent-team/README.md: add concrete gh workflow run examples for
  manual re-dispatch of each agent role, complementing the fail-loud input
  contract added in #69

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