docs: fix uninstall label list, outdated testing section, broken publishing link#130
Draft
github-actions[bot] wants to merge 1 commit into
Draft
Conversation
…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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three documentation bugs caught during nightly doc review.
Changes
1. README.md — Uninstall label list was wrong
The
agent-teamuninstall instructions listedin-progress(a label that does not exist) and omittedagent-team:reviewed(the actual seventh label created by/install-agent-team). The prose formatstate:<name> for each of ...was also easy to misread.Fix: replaced with seven explicit
gh label deletecommands that exactly match whatinstall-agent-team/SKILL.mdcreates.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.shas the pre-PR gate, adds a tier summary table, and links totests/README.mdfor 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", butREADME.mdhas no#publishinganchor — 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
skills/install-agent-team/SKILL.mdgh label createcommands (they do)./tests/run-tests.shcommand — file exists and is executable (tests/run-tests.sh)README.mdhas no#publishinganchor that the old CONTRIBUTING link was meant to target (confirmed absent)