docs: rework README — pitch-first, operations move to topic pages#21
Merged
Conversation
The README had grown to 488 lines with two quickstarts, a ~100-line Remote section, benchmark detail accidentally INSIDE the install code fence (the fence opened at the cargo block never closed before it), and a How-it-works section duplicating the reference doc. Now 172 lines: tagline -> why -> compact how-it-works -> ONE quickstart (install, setup one-shot, selftest, first memory) -> 4-line benchmark blurb -> 8-line Remote teaser -> what's-in-the-box -> docs index. Operational content moved VERBATIM (numbers are audit-verified) to two new topic pages: - docs/INSTALL.md — install paths (cargo/npm/prebuilt), host wiring matrix, auto-harvest + distiller, config toggles, maintenance & lifecycle. - docs/REMOTE.md — full server setup, client wiring, retrieval quality, server-side ingest + repos.toml. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
2 participants
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
docs/INSTALL.md(install paths, host wiring, harvest/distiller, maintenance) anddocs/REMOTE.md(full server setup, ingest, retrieval quality).Test Plan
🤖 Generated with Claude Code