Repository navigation
docs: align README with go-coding layout, drop the Status column - #4
Merged
Merged
Conversation
Restructure README.md to follow the go-coding-plugin README: intro naming the hosts and hook set, Features, Installation, a Components table, a grounding-sources paragraph, one plugin-specific section (How it decides), Development, Documentation, then the AGENTS.md pointer and License. - Remove the Status column; every row said "shipped" and carried no signal. - Fold "The rule that defines it" into "How it decides"; the full rule stays in references/claims-and-evidence.md. - Split references/vale.ini into its own Components row and state the agents' Bash-but-no-Write tool grant. - Fix over-broad claims found while verifying against the tree: the claims rule, the read-the-repo-first step, and the Vale step apply to the writing and editing skills (and the router), not to every skill. Line-edit docs/install.md, docs/testing.md and docs/authoring.md for readability, and fix stale facts: CI runs scripts/validate.py directly, a missing agent tools: key is also an error, the Cursor-only rule differs between hosts, the prose-lint hook also accepts _vale.ini, and the references list now includes ai-tells.md. 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
Readability and AI-tell cleanup of the human-facing docs, with
README.mdrestructured to follow thego-coding-pluginREADME.README.md
How it decides), Development, Documentation, theAGENTS.mdpointer, License.Statuscolumn is gone fromComponents. Every row saidshipped.The rule that defines itis folded intoHow it decides. The full rule still lives inreferences/claims-and-evidence.md.RoutingandCursor parityfeatures, areferences/vale.inirow, and a sentence on the agents'Bash-but-no-Writetool grant./docs-lint-setupdoes not.seo-auditorusesBashfor builds, greps, and fetches, not for linters.doc-types.md§3 lists four inversions for agent-instruction files, not three.docs/
install.md:_vale.inialternative is now mentioned.testing.md:scripts/validate.pydirectly and installs Python 3; it does not runvalidate.shor pin a Python version.tools:key is also an error.authoring.md:ai-tells.mdis added to the references list, and one sentence with stacked colons is rewritten.CHANGELOG.md: new
[Unreleased]bullets under Changed and Fixed.Agent-instruction files (
AGENTS.md,CLAUDE.md, skills, agents, rules) andreferences/are untouched.Verification
./scripts/validate.sh: OK, including Markdown links and anchors.claude plugin validate .: passed. Its two warnings are about unquoted${CLAUDE_PLUGIN_ROOT}inhooks/hooks.json; they were already there and are not part of this change.references/vale.iniand theai-tellsstyle:docs/, CHANGELOG, and the PR template.ai-tellsalerts and no em dashes.testing.mdtest recipe, plusCadastohits because the seed vocabulary does not list it.prose-revieweragent pass over the diff; its findings are fixed in this PR.Checklist
./scripts/validate.shpassesclaude plugin validate .passes[Unreleased])🤖 Generated with Claude Code