Skip to content

docs: fix label names, add Publishing section, correct test runner flags#64

Draft
github-actions[bot] wants to merge 1 commit intomainfrom
docs/fix-label-names-publishing-test-flags-cad22222c27d0e52
Draft

docs: fix label names, add Publishing section, correct test runner flags#64
github-actions[bot] wants to merge 1 commit intomainfrom
docs/fix-label-names-publishing-test-flags-cad22222c27d0e52

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Four documentation gaps found during a routine doc sweep against the current code:

Changes

README.md — wrong label in Uninstall section

The uninstall instructions listed state:in-progress as one of the seven agent-team labels to delete. The label that install-agent-team actually creates is agent-team:reviewed (verified against skills/install-agent-team/SKILL.md and catalog/agent-team/README.md). Fixed the list to match.

README.md — missing ## Publishing section

CONTRIBUTING.md has a "Publishing (maintainers only)" heading that links to README.md#publishing, but that anchor did not exist — a broken reference on every contributor's first PR. Added a concise Publishing section covering version bump, tagging, GitHub release, and registry submissions.

CONTRIBUTING.md — Testing section claimed no automated test harness

The section opened with "There is no automated test harness for skills" but tests/run-tests.sh runs tier-2 invariants + tier-1 skill assertions on every CI run. Rewrote the section to show the runner commands and point to tests/README.md for the full tier breakdown.

tests/README.md--tier3 flag doesn't exist

The tier-3 table row for test-e2e.sh said to opt in via --tier3, but run-tests.sh has no such flag (--with-e2e covers the daily light E2E only; test-e2e.sh must always be invoked directly). Updated the cell to say "invoke directly" with the correct command.

Test plan

  • Verify test-invariants.sh still passes (the README.md#publishing anchor check is not in invariants, but the version-sync and dogfood-path checks still apply)
  • Confirm the four label names in README.md Uninstall now match the gh label create commands in skills/install-agent-team/SKILL.md
  • Follow the README.md#publishing link from CONTRIBUTING.md and confirm it resolves

🤖 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

Four documentation gaps found during routine doc sweep:

- README.md: Uninstall section listed `state:in-progress` for agent-team
  label cleanup, but the label the install skill actually creates is
  `agent-team:reviewed`. Fixed to match the skill and catalog/agent-team
  README verbatim.

- README.md: Added missing `## Publishing` section. CONTRIBUTING.md has a
  "Publishing (maintainers only)" heading that links to `README.md#publishing`,
  but that anchor did not exist, leaving a broken reference.

- CONTRIBUTING.md: Testing section said "no automated test harness" but
  `tests/run-tests.sh` runs tier-2 invariants + tier-1 skill assertions on
  every CI run. Rewrote the section to reference the runner and point to
  tests/README.md.

- tests/README.md: Table row for `test-e2e.sh` said to opt in via `--tier3`,
  a flag that does not exist in `run-tests.sh`. Clarified that `test-e2e.sh`
  must be invoked directly and is never managed by the runner.

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