Skip to content

docs: fix outdated testing section, broken publishing link, agent-team input table#138

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-testing-section-and-agent-team-inputs-173e2cd900bec86b
Draft

docs: fix outdated testing section, broken publishing link, agent-team input table#138
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-testing-section-and-agent-team-inputs-173e2cd900bec86b

Conversation

@ghost
Copy link
Copy Markdown
Contributor

@ghost ghost commented May 24, 2026

Three documentation gaps addressed by this PR, all identified during the post-commit docs sweep triggered by d688265.

Changes

CONTRIBUTING.md — Testing section rewrite

The previous version stated "There is no automated test harness for skills", which has been incorrect since the tests/ directory was added. This misleads contributors into thinking the only verification path is a manual skill walkthrough.

Replaced with the actual tier structure (tier-2 grep invariants <1s, tier-1 Claude-invoked assertions ~4-5min, tier-3 manual E2E) and a quick-reference table mapping each changed area to the correct test command.

README.md — Add missing #publishing section

CONTRIBUTING.md line 115 links to README.md#publishing but that anchor did not exist. Added a brief maintainer-only publishing section covering version bumping, GitHub Release creation, and registry submission steps.

catalog/agent-team/README.md — Input table and manual-dispatch clarity

Triggered by the recent fix to agent-team workflow_dispatch inputs (#69):

  • Files table: expanded with Required/Optional input columns so it's clear at a glance which inputs each role expects and which have defaults.
  • Input validation note: added below the table to explain the fail-loud behavior for missing/unresolved inputs, and to explicitly call out that pr_number is the one intentionally optional input (blank → new PR branch; real value → push to existing PR).
  • "Kicking off a task" step 4: replaced the vague "must pass the required workflow_dispatch inputs" with concrete gh workflow run --field examples for planner, implementer, and reviewer.
  • "Limits and gotchas" Input propagation bullet: sharpened to distinguish required vs optional inputs.

Testing

No code changes — documentation only. Verified by reading the modified files against the source-of-truth (implementer-agent.md frontmatter, tests/run-tests.sh, tests/README.md).

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

Generated by Update Docs ·

To install this agentic workflow, run

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

…m input table

Three documentation gaps addressed:

- CONTRIBUTING.md: replace the incorrect "no automated test harness" claim
  with the actual tier-1/tier-2/tier-3 structure from tests/README.md,
  including a quick-reference table mapping changed areas to test commands.
- README.md: add missing #publishing section (CONTRIBUTING.md linked to it
  but the anchor didn't exist).
- catalog/agent-team/README.md: expand Files table with required/optional
  input columns; document that pr_number is intentionally optional on first
  impl (blank → new branch, real value → push to existing PR); improve
  manual-dispatch examples in "Kicking off a task" step 4; sharpen the
  Input propagation gotcha to distinguish required vs optional inputs.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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