Skip to content

docs: drop the README Status column and align docs with sibling plugins - #8

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

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

  • The Status column is gone from Components. Every row said shipped.
  • The rows are grouped by kind: skills, agent, hooks, config, rule.
  • The dev scripts (hooks-test.sh, usage-report.py) move from Components to Development.
  • Stale facts fixed, checked against the tree:
    • scripts/hooks-test.sh tests all three hook scripts, not two.
    • The validator has three plugin-specific invariants, not two; the README had left out the Google tie-break sentence. The README now links their definitions in docs/testing.md instead of restating them.
    • /go-lint-setup writes a copy of references/golangci.v2.yml; it does not read the file.
    • usage-report.py also counts go-reviewer dispatches.
  • The wording now follows the docs-editing README: label punctuation, an audience sentence, and the component counts (7 skills, 1 agent, 3 hooks, 1 rule).

docs/

  • testing.md:
    • New What scripts/validate.py checks subsection, mirroring docs-editing. It covers the structural checks and the three Go-specific invariants.
    • It no longer claims the validator requires an agent tools: key. The validator only rejects allowed-tools:.
    • CI installs Python 3; it does not pin a version.
    • The /go-lint-setup triggering 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, and authoring.md drop their ~100-column hard wraps for one line per paragraph, like install.md and the sibling plugins. A whitespace-normalised comparison confirmed the text is otherwise unchanged.
  • authoring.md:
    • "command" is dropped from the title, since there is no commands/.
    • The Google-internal exclusions now render as their own paragraph instead of merging into the Best Practices bullet.
    • The bold lead-ins inside procedure steps 1 and 4 get their own paragraphs.

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.
  • Vale 3.18.0 with the docs-editing reference config and the ai-tells style: no ai-tells alerts, and no em dashes added.
  • A docs-editing:prose-reviewer pass over the diff found one blocker (the tools: overclaim) and several minor issues; all are fixed in this PR.

Follow-ups, not in this PR

  • scripts/validate.py does not flag an agent that has no tools: key at all; the docs-editing validator does. The docstring at validate.py:12-14 still says it does.
  • AGENTS.md and the comment in scripts/validate.sh still say "CI pins Python".

Checklist

  • ./scripts/validate.sh passes
  • claude plugin validate . passes
  • Docs synced; the inventory check passes
  • Version bump: not needed (docs only; entries sit under [Unreleased])

🤖 Generated with Claude Code

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>
@sebastian-iancu
sebastian-iancu merged commit ef807f8 into main Oct 1, 2026
3 checks passed
@sebastian-iancu
sebastian-iancu deleted the docs/readme-readability branch October 1, 2026 12:39
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