Skip to content

docs: update README - #9

Draft
alexdukeinvertase wants to merge 1 commit into
invertase:mainfrom
alexdukeinvertase:chore/update-readme
Draft

alexdukeinvertase wants to merge 1 commit into
invertase:mainfrom
alexdukeinvertase:chore/update-readme

Conversation

@alexdukeinvertase

@alexdukeinvertase alexdukeinvertase commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

Summary

Short README front door: pitch, dedicated-test-app callout, agent one-liner → app-developers.md, install/CI. Drops the long why / Pattern C / Codecov tour. Docs links use the new paths; releasing points at docs.page /releasing.

Depends on #8 — merge that first so the new docs paths exist.

Outside this PR: GitHub About + npm description (About is empty today).

Test plan

  • Every README URL returns 200 (docs.page, CONTRIBUTING, Codecov, npm, GitHub, images)
  • No stale primary links (/why, /pattern-c, /cli, /config)
  • Pitch matches Overview/Coverage; agent one-liner matches /app-developers
  • On hosted docs, /coverage#dedicated-test-app lands correctly
  • Note remaining human follow-up: GitHub About + npm description

Co-authored-by: Cursor <cursoragent@cursor.com>
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