docs: drop the README Status column and align docs with sibling plugins - #8
Merged
Merged
Conversation
README.md: - Remove the Status column; every row said "shipped". - Group Components rows by kind (skills, agent, hooks, config, rule) and move the dev scripts to Development. - Fix stale facts: hooks-test.sh covers all three hooks, and the validator has three plugin-specific invariants (the Google tie-break sentence was missing). Link docs/testing.md for their definitions. - Match the docs-editing README conventions: label punctuation, the audience sentence, the Claude Code install line. docs/: - testing.md gains a "What scripts/validate.py checks" subsection covering the structural checks and the three invariants, and stops claiming the validator requires an agent `tools:` key (it rejects `allowed-tools:` only). CI installs Python 3; it does not pin it. - install.md: the Cursor-only rule differs between hosts; line edits. - testing.md, versioning.md and authoring.md drop ~100-column hard wraps for one line per paragraph, like install.md and the sibling plugins. authoring.md drops "command" from its title, and the Google-internal exclusions render as their own paragraph. Co-Authored-By: Claude Opus 5.5 <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.
Summary
This tidies the readability of the human-facing docs and removes AI-sounding phrasing. It also brings the README and
docs/layout in line with the other Cadasto plugins (docs-editing, sdd, openehr-assistant).README.md
Statuscolumn is gone fromComponents. Every row saidshipped.hooks-test.sh,usage-report.py) move fromComponentstoDevelopment.scripts/hooks-test.shtests all three hook scripts, not two.docs/testing.mdinstead of restating them./go-lint-setupwrites a copy ofreferences/golangci.v2.yml; it does not read the file.usage-report.pyalso countsgo-reviewerdispatches.docs/
testing.md:What scripts/validate.py checkssubsection, mirroring docs-editing. It covers the structural checks and the three Go-specific invariants.tools:key. The validator only rejectsallowed-tools:./go-lint-setuptriggering test now has an expected result.install.md: the Cursor-only rule now appears among the host differences, plus line edits.testing.md,versioning.md, andauthoring.mddrop their ~100-column hard wraps for one line per paragraph, likeinstall.mdand the sibling plugins. A whitespace-normalised comparison confirmed the text is otherwise unchanged.authoring.md:commands/.CHANGELOG.md: new
[Unreleased]bullets under Changed and Fixed.AGENTS.md, the skills, the agent, the rules, and the scripts are untouched.Verification
./scripts/validate.sh: OK. The Fixer-column check soft-skipped because the local Go is 1.27; CI's 1.26.x matrix entry runs it.python3 scripts/validate.py --selftest: 9/9 checks caught their failure case../scripts/hooks-test.sh: all pass.claude plugin validate .: passed.ai-tellsstyle: noai-tellsalerts, and no em dashes added.docs-editing:prose-reviewerpass over the diff found one blocker (thetools:overclaim) and several minor issues; all are fixed in this PR.Follow-ups, not in this PR
scripts/validate.pydoes not flag an agent that has notools:key at all; the docs-editing validator does. The docstring atvalidate.py:12-14still says it does.AGENTS.mdand the comment inscripts/validate.shstill say "CI pins Python".Checklist
./scripts/validate.shpassesclaude plugin validate .passes[Unreleased])🤖 Generated with Claude Code