Skip to content

docs: fix uninstall label list, outdated testing section, broken publishing link#130

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-uninstall-labels-and-contributing-testing-63ceb86f700fc86c
Draft

docs: fix uninstall label list, outdated testing section, broken publishing link#130
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-uninstall-labels-and-contributing-testing-63ceb86f700fc86c

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Three documentation bugs caught during nightly doc review.

Changes

1. README.md — Uninstall label list was wrong

The agent-team uninstall instructions listed in-progress (a label that does not exist) and omitted agent-team:reviewed (the actual seventh label created by /install-agent-team). The prose format state:<name> for each of ... was also easy to misread.

Fix: replaced with seven explicit gh label delete commands that exactly match what install-agent-team/SKILL.md creates.

2. CONTRIBUTING.md — Testing section claimed no automated harness exists

The section opened with "There is no automated test harness for skills", which has been false since the tests/ directory was added. The actual suite has three tiers (filesystem invariants, headless skill tests, E2E) and CI runs tiers 2 + 1 on every PR.

Fix: documents ./tests/run-tests.sh as the pre-PR gate, adds a tier summary table, and links to tests/README.md for the full reference. Preserved the manual validation steps that have no automated equivalent (plugin load check, gh aw validate, OAuth grep counts).

3. CONTRIBUTING.md — Publishing section pointed to a missing README anchor

The ## Publishing (maintainers only) section said "See the Publishing section of the README", but README.md has no #publishing anchor — the link was always broken.

Fix: replaced the broken link with the three actual publishing steps (version bump in plugin.json, GitHub Release, registry listing updates on claude-plugins.dev and ClaudePluginHub).

Test plan

  • Read the diff — all three changes are documentation-only; no code paths altered
  • Verify the seven label names match skills/install-agent-team/SKILL.md gh label create commands (they do)
  • Click ./tests/run-tests.sh command — file exists and is executable (tests/run-tests.sh)
  • Verify README.md has no #publishing anchor that the old CONTRIBUTING link was meant to target (confirmed absent)

Generated by Update Docs ·

To install this agentic workflow, run

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

…ishing link

Three documentation bugs caught during routine doc review:

1. README.md § Uninstall: listed `in-progress` (non-existent label) instead
   of `agent-team:reviewed`, and used an ambiguous prose format. Replaced with
   explicit `gh label delete` commands matching the seven labels that
   `install-agent-team` actually creates.

2. CONTRIBUTING.md § Testing: claimed "there is no automated test harness",
   which has been false since the three-tier `tests/` suite was added. Updated
   to document the tier-2/1 commands to run before every PR and the tier-3
   opt-in E2E tests to run before releases.

3. CONTRIBUTING.md § Publishing: pointed to a non-existent `README.md#publishing`
   anchor. Replaced with the actual three steps (version bump, GitHub Release,
   registry listings).

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