docs: shorten README, split depth into docs/, kill kimi drift#48
Merged
Conversation
README drops 533 -> 257 lines by moving depth out, not by cutting it: install/runtime/options -> docs/install.md, capture scope + proxy internals -> docs/capture-modes.md, the UI tour -> docs/web-ui.md, saved-trace commands + housekeeping guarantees -> docs/traces.md, codex/grok/kimi + compat providers -> docs/clients.md. GitHub Pages already builds from main:/docs, so the split lands on the site for free. README gains a nav line, an agent pointer, and a docs table; keeps hook -> proof -> 60-second start -> cheat sheet. zh README mirrors the same structure (and loses its stale "HTML snapshot at exit" claim, dead since 0.13). llms.txt maps the new doc pages and names each client's wire session-id location. docs/index.html catches up with kimi (title, meta, hero, feature card, 0.19 roadmap row). 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
1 participant
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.
What
Post-0.19 burnish. The README was 533 lines — depth imposed, not offered. It drops to 257 by moving detail, not cutting it:
--caveat, full optionsGitHub Pages already builds from
main:/docs, so the split lands on the site with zero plumbing.README keeps the decision path: hook → what you get → comparison → 60-second start → everyday commands → common options → diagram → security. Gains a nav line, an agent pointer (
llms.txt), and a curated docs table.Also:
prompt_cache_key)No code changes;
bun test477 pass.🤖 Generated with Claude Code