docs: rewrite README in ruflo-style#76
Merged
Merged
Conversation
The previous README was 2,223 lines of feature lists, version matrices, integration examples, and historical content that mostly duplicated docs/ — it had grown into a small website rather than an entry point. Rewrite as a 200-line top-of-funnel: one-line elevator pitch, a "Why" paragraph, a "What it does" ASCII diagram, three install paths, a capability table, collapsible deep-dives, and pointers to the four canonical docs. Borrowed structure (not content) from ruvnet/ruflo's README: - Centered badge cluster up top - Why X / What X Does intro - Quick Start comparison table (3 install paths) - "What You Get" capability table - Collapsible <details> for crate matrix + architecture + WASM - Documentation table → 4 canonical docs + ADR index - Single Support table at the bottom Content is midstream-specific: 6 published Rust libs, inflight analysis story, ADR references, performance numbers from docs/BENCHMARKS.md, dev workflow that matches our CI gates (with --exclude midstream while ADR-0005 lean_agentic retirement is in flight). Co-Authored-By: claude-flow <ruv@ruv.net>
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.
Summary
The previous README was 2,223 lines of feature lists, version matrices, integration examples, and historical content that mostly duplicated `docs/` — it had grown into a small website rather than an entry point.
Rewrite as a 200-line top-of-funnel:
Details
` blocks for the crate matrix, npm packages, WASM, and the architecture diagramStructure borrowed from `ruvnet/ruflo`'s README (centered badge cluster, Why X / What X Does, capability table, collapsible details, four-doc index). Content is midstream-specific: the 6 published Rust libs, inflight-analysis story, ADR references, perf numbers from `docs/BENCHMARKS.md`, dev workflow matching the current CI gates (incl. `--exclude midstream` while ADR-0005's lean_agentic retirement is in flight).
Test plan
Details
` blocks render correctly🤖 Generated with claude-flow