docs(readme): slim README 1394→490 lines; move full detail into docs/…#127
Merged
Conversation
…guides The README had grown to 1394 lines / 82 KB. Trim it to a focused ~490-line landing page and relocate the long-form content to dedicated guides so nothing is lost — every condensed section links to its full version. New guides (full content preserved verbatim): - docs/guides/features.md — the complete feature table (context-compression layers, auto-fanout, 15 themes, full Trading/Research/Agents writeups) - docs/guides/usage.md — per-provider setup + examples (Anthropic, OpenAI, Gemini, Kimi, Qwen, Zhipu, DeepSeek, MiniMax, litellm) and local Ollama / LM Studio / vLLM - docs/guides/comparison.md — full vs Claude Code + vs OpenClaw analysis - docs/guides/faq.md — the full FAQ README changes: - Features / Usage / comparisons / FAQ condensed to summaries that link out. - Web UI + Trading already had complete guides (web-ui.md, trading.md) — README now just summarizes and links. - News: dropped the commented-out historical block (it duplicates docs/news.md). - Removed two pre-existing dead links to docs/comparison_*_v3.03_*.md (files never existed) — replaced by docs/guides/comparison.md. - Documentation index gains Features / Usage / Comparison / FAQ rows. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Ari4ka
approved these changes
May 31, 2026
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.
…guides
The README had grown to 1394 lines / 82 KB. Trim it to a focused ~490-line landing page and relocate the long-form content to dedicated guides so nothing is lost — every condensed section links to its full version.
New guides (full content preserved verbatim):
layers, auto-fanout, 15 themes, full Trading/Research/Agents writeups)
Gemini, Kimi, Qwen, Zhipu, DeepSeek, MiniMax, litellm) and local Ollama /
LM Studio / vLLM
README changes: