Skip to content

docs: align README with go-coding layout, drop the Status column - #4

Merged
sebastian-iancu merged 1 commit into
mainfrom
docs/readme-readability
Oct 1, 2026
Merged

sebastian-iancu merged 1 commit into
mainfrom
docs/readme-readability

Conversation

@sebastian-iancu

Copy link
Copy Markdown
Contributor

Summary

Readability and AI-tell cleanup of the human-facing docs, with README.md restructured to follow the go-coding-plugin README.

README.md

  • Section order now matches go-coding: intro (hosts and hook set named), Requirements, Features, Installation, Components, a grounding-sources paragraph, one plugin-specific section (How it decides), Development, Documentation, the AGENTS.md pointer, License.
  • The Status column is gone from Components. Every row said shipped.
  • The rule that defines it is folded into How it decides. The full rule still lives in references/claims-and-evidence.md.
  • New: Routing and Cursor parity features, a references/vale.ini row, and a sentence on the agents' Bash-but-no-Write tool grant.
  • Over-broad claims fixed after checking them against the tree:
    • Not every skill applies the claims rule; /docs-lint-setup does not.
    • The read-the-repo-first step lives in the router and the Cursor rule, not in each skill.
    • seo-auditor uses Bash for builds, greps, and fetches, not for linters.
    • doc-types.md §3 lists four inversions for agent-instruction files, not three.

docs/

  • install.md:
    • Line edits.
    • The host differences now include the Cursor-only rule.
    • The _vale.ini alternative is now mentioned.
    • "Save hook" is now "prose-lint hook".
  • testing.md:
    • CI runs scripts/validate.py directly and installs Python 3; it does not run validate.sh or pin a Python version.
    • A missing agent tools: key is also an error.
  • authoring.md: ai-tells.md is 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) and references/ 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} in hooks/hooks.json; they were already there and are not part of this change.
  • Vale 3.18.0 with the plugin's references/vale.ini and the ai-tells style:
    • 329 alerts before, 315 after, over README, docs/, CHANGELOG, and the PR template.
    • No ai-tells alerts and no em dashes.
    • The only error left is the quoted, planted "simply" in a testing.md test recipe, plus Cadasto hits because the seed vocabulary does not list it.
  • prose-reviewer agent pass over the diff; its findings are fixed in this PR.

Checklist

  • ./scripts/validate.sh passes
  • claude plugin validate . passes
  • No unsourced claim added
  • Inventories and counts in README verified against the tree
  • Version bump: not needed (docs only; entries sit under [Unreleased])

🤖 Generated with Claude Code

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>
@sebastian-iancu
sebastian-iancu merged commit 4422d09 into main Oct 1, 2026
1 check passed
@sebastian-iancu
sebastian-iancu deleted the docs/readme-readability branch October 1, 2026 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant