Skip to content

docs: rewrite README as a lean landing page - #39

Merged
Mapika merged 1 commit into
mainfrom
docs/readme-rewrite
Jun 5, 2026
Merged

docs: rewrite README as a lean landing page#39
Mapika merged 1 commit into
mainfrom
docs/readme-rewrite

Conversation

@Mapika

@Mapika Mapika commented Jun 5, 2026

Copy link
Copy Markdown
Owner

Restructures the README so the useful parts come first and the reference material stops being a wall.

  • Quick start up top — install → run a model → curl it, before any philosophy.
  • Deduped the three overlapping when-to-use / non-goals / multi-node sections into one each.
  • Collapsed reference — full CLI table, ~/.berth tree, architecture diagram, and perf numbers moved into <details> blocks.
  • Added the new surfaces/v1/responses and adopting an already-running server.
  • Keeps the author's voice; ~583 → ~316 lines (and a much shorter above-the-fold).

Doc-only change.

🤖 Generated with Claude Code

Front-load the quick start, dedupe the scattered when-to-use/non-goals/
multi-node sections, fold the CLI table, ~/.berth tree, architecture
diagram, and perf numbers into collapsible <details>, and add the new
adopt + Responses API surfaces. Keeps the author's voice; ~583 -> ~316
lines with a much shorter above-the-fold.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@Mapika
Mapika merged commit 73b4c55 into main Jun 5, 2026
3 checks passed
@Mapika
Mapika deleted the docs/readme-rewrite branch June 5, 2026 15:01
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