docs: split 593-line README into focused top page + docs/ - #12
Merged
Conversation
The README had grown to 593 lines, burying install/run basics under protocol, deployment, integration, and migration detail. Keep the preamble, V1 scope, running the server, the `just` operator recipes, and backend/model selection on the top page; move the rest verbatim into: - docs/operations.md — multi-backend op, two-agent install, A/B benchmark, health checks, Whisper hallucination knobs - docs/integration.md — client usage, Pipecat integration, Koda reference - docs/protocol.md — V1 wire protocol - docs/migration.md — 0.1.x -> 0.2.0 upgrade Content moved verbatim (comm-verified: only deliberately re-leveled headings + repointed cross-links differ from the original). A README Documentation index links the four files; all internal links and anchors resolve (checked). README 593 -> ~190 lines.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The README had grown to 593 lines, burying install/run basics under protocol, deployment, integration, and migration detail. This splits it so the top page stays focused on why it exists + install + run, and the deeper material moves to thematic files under
docs/.README keeps: preamble (why it exists), V1 scope, Running the server, Managing agents with
just, Choosing a backend and model, and a new Documentation index. 593 → ~190 lines.Moved verbatim to
docs/:docs/operations.mddocs/integration.mddocs/protocol.mddocs/migration.mdPer request, the
justoperator recipes stay on the top page (promoted to their own## Managing agents with just); only the per-ASR reference table they cite moved (link repointed).Verification
commdiff of original README vs the union of all new files shows only the 12 lines I deliberately changed — 4 re-leveled headings + 8 repointed cross-references. Everything else is byte-identical (extracted withsed, not retyped).Docs-only — no code changes.