Skip to content

docs: shorten README to 77 lines (PROJ-914) - #398

Merged
TAJD merged 1 commit into
mainfrom
docs/readme-simplify
Oct 4, 2026
Merged

TAJD merged 1 commit into
mainfrom
docs/readme-simplify

Conversation

@TAJD

@TAJD TAJD commented Oct 4, 2026

Copy link
Copy Markdown
Owner

Summary

Applies the README draft from PROJ-914 (213 → 77 lines). Done at the user's explicit request, which overrides the AGENTS.md "human-authored" rule for this change; CODEOWNERS review still applies. Follows the PROJ-914 outline: what it is, why it's different (4 bullets linking to docs), get started (deploy, connect), docs table, development commands, contributing.

Dropped, per PROJ-914: the OAuth/RFC paragraph (the "token minted for one workspace is not a credential for another" claim is false until PROJ-903), the long work-graph/contention/parity sections (live in the philosophy pages and, for parity, system-design via #397), and the stale "pre-push hook" line. Kept the gen-mcp-stats marker so pnpm gen:docs still works.

Verified

  • All 12 links return 200; claude mcp add and dev commands match the docs/AGENTS.md; image and root files exist.
  • pnpm gen:docs leaves no diff; workflow.test.ts passes.

Assumed

  • The "Deploy to Cloudflare" button's behaviour on the deploy repo (link checked for 200 only).

🤖 Generated with Claude Code

https://claude.ai/code/session_014JyYB2AfPyH695ScaeCofW

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014JyYB2AfPyH695ScaeCofW
@TAJD
TAJD merged commit 6a9676c into main Oct 4, 2026
1 check passed
@TAJD
TAJD deleted the docs/readme-simplify branch October 4, 2026 14:43
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