Skip to content

docs: README rewrite + generated catalog table - #11

Merged
SuperElectron merged 1 commit into
stagingfrom
docs/rewrite
Aug 27, 2026
Merged

docs: README rewrite + generated catalog table#11
SuperElectron merged 1 commit into
stagingfrom
docs/rewrite

Conversation

@SuperElectron

Copy link
Copy Markdown
Owner

Phase 11. The README is rewritten for its actual audience — someone scanning the repo on GitHub:

  • Opens with WHY in one short paragraph, no definitions or history
  • How to read one unit + one claude mcp add command
  • Catalog table generated from frontmatter (make readme); a new CI step fails on drift, so it can never rot back into "builder description"
  • Ends with one link to docs/ — no changelogs, roadmaps, or process content

New docs pages: how-to-read-this-repo.md, verdicts.md, contributing.md. All relative links verified to resolve.

🤖 Generated with Claude Code

README: minimal and WHY-first for someone scanning the repo on
GitHub — what it is, how to read one unit, one MCP command, then the
catalog table generated from frontmatter (make readme). CI fails if
the table drifts.

docs/: how-to-read-this-repo, verdicts, contributing, index; mcp.md
landed with the server.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@SuperElectron
SuperElectron merged commit bc57d94 into staging Aug 27, 2026
3 checks passed
@SuperElectron
SuperElectron deleted the docs/rewrite branch August 27, 2026 00: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