Skip to content

docs: delete docs/, root CONTRIBUTING.md, one-table minimal README - #27

Merged
SuperElectron merged 4 commits into
stagingfrom
feat/v2-docs-trim
Aug 27, 2026
Merged

docs: delete docs/, root CONTRIBUTING.md, one-table minimal README#27
SuperElectron merged 4 commits into
stagingfrom
feat/v2-docs-trim

Conversation

@SuperElectron

Copy link
Copy Markdown
Owner

Mat's call: docs/ was AI-slop-adjacent meta the product never uses.

  • docs/ deleted entirely (index, verdicts, how-to-read, mcp, contributing — 5 files).
  • CONTRIBUTING.md at repo root — the GitHub-standard location (auto-surfaced in PR/issue UI); content trimmed, dead links repointed at CLAUDE.md.
  • MCP usage = minimal bullets at the top of README (connect command, the three access levels, HTTP mode, sandbox contract).
  • README trimmed to 75 lines: tight intro, MCP bullets, unit anatomy, and one single catalog table (Group column added; generator readme_table.py updated — drift check still enforced by CI).
  • Dangling docs/verdicts.md references removed from CLAUDE.md/AGENTS.md (verdicts are defined there already, and spelled out in the table).

make check green (547 tests, readme drift check current).

Note: PR #26 (main.py rename) is open in parallel and also touches README's run command — whichever merges second, I'll rebase and resolve.

Held for Mat's review.

🤖 Generated with Claude Code

SuperElectron and others added 4 commits August 27, 2026 14:47
…alog table

docs/ was human-facing meta the MCP never serves: contributing moves to the
GitHub-standard root file, MCP usage becomes bullets at the top of README,
the rest (index/verdicts/how-to-read) is deleted — verdicts are spelled out
in the table itself. Table generator emits one table with a Group column.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
# Conflicts:
#	docs/how-to-read-this-repo.md
@SuperElectron
SuperElectron merged commit 89148d6 into staging Aug 27, 2026
3 checks passed
@SuperElectron
SuperElectron deleted the feat/v2-docs-trim branch August 27, 2026 21: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