Skip to content

docs: stop counting diagnostics in the root README - #9

Merged
Katyara11 merged 1 commit into
mainfrom
docs/stop-counting-diagnostics
Nov 7, 2026
Merged

Katyara11 merged 1 commit into
mainfrom
docs/stop-counting-diagnostics

Conversation

@Katyara11

Copy link
Copy Markdown
Member

Summary

The root README claimed "eighteen diagnostics" against a live set of twenty-three.

Changes

  • Replaces the count with examples and a link to docs/diagnostics.md.

Type

  • Feature
  • Bug fix
  • Refactor
  • Chore (CI, deps, config)

Checklist

  • Code builds without errors
  • Tests added/updated

Notes for review

Four PRs added diagnostics and each updated the page it was thinking about — the root README was
nobody's page. Rather than correct the number to one that will drift again, it now names examples
and links the reference. A count in prose is a maintenance burden that buys the reader nothing the
link doesn't.

It said "eighteen" against a live set of twenty-three. Four PRs added
diagnostics and each updated the page it was thinking about; the root README
was nobody's page.

Replaced the count with examples and a link to the reference, which is
generated from nothing and therefore cannot drift. A number in prose is a
maintenance burden that buys the reader nothing a link does not.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@Katyara11
Katyara11 merged commit 6556eea into main Nov 7, 2026
2 checks passed
@Katyara11
Katyara11 deleted the docs/stop-counting-diagnostics branch November 7, 2026 11:50
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