docs(readme): rewrite for v2.2.0 (AgentDB-first, ruflo-style) - #11
Merged
Conversation
Replaces the 2.0/2.1-era README (which advertised modules that don't exist — ProgramOfThought, MultiChainComparison, Refine, majority — and unverified perf claims). New README mirrors the ruflo README layout: centered badge block → tagline → "Why" quote → "What it does" ASCII flow diagram → Quick Start (compile example + RAG + experience-replay) → "What you get" capability table → collapsed <details> for modules / optimizers / AgentDB layer / examples → Documentation → an honest "Roadmap & known limitations" section → License. Reflects the actual v2.2.0 surface: Predict / ChainOfThought / ReAct(+reflexion) / Retrieve / Pipeline; BootstrapFewShot(+dynamic demos) / MIPROv2(+experience replay) / GEPA; AgentDBClient (HNSW, RaBitQ, tiers) / ReasoningBank(+SAFLA); CachingLM; CompilationTracer; multi-provider LM drivers. Co-Authored-By: RuFlo <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.
Replaces the 2.0/2.1-era README with one that (a) matches the current v2.2.0 surface, (b) is honest about what exists vs. what's a TODO, and (c) follows the ruflo README layout: badge block → bold tagline → "Why" quote → "What it does" ASCII flow diagram → Quick Start (compile example + RAG with
Retrieve+ MIPROv2 experience replay) → "What you get" capability table → collapsed<details>for modules / optimizers / the AgentDB memory layer / examples → Documentation → "Roadmap & known limitations" → License.The old README claimed
ProgramOfThought/MultiChainComparison/Refine/majoritymodules and "75x faster" perf — none of which are insrc/— and a "vs DSPy Python ✅" matrix that didn't match reality. The new one lists only what's actually shipped.No code changes.
npm run docsuses--readme none, so the API docs build is unaffected.🤖 Generated with RuFlo