docs(readme): tremendous overhaul — ToC, getting started, examples for every capability#84
Merged
Merged
Conversation
…r every capability Rewrites the README around the full current surface (0.39.0), not just chat turns: - Table of Contents (anchored) + a clean "getting started" (the 20-line handleChatTurn). - A "which entry point" decision table mapping intent → API → subpath. - A Capabilities section with a copy-pasteable example for each: driven loops + topology drivers, agent-authored dynamic topology (createDynamicDriver + createSandboxPlanner), the delegated loop-runner (runDelegatedLoop + the new agent-runtime-loop bin), reliable build-in-a-loop (coder delegate gates), valid-only research (createKbGate), identity-gated optimizePrompt, OTel GenAI topology tracing (buildLoopOtelSpans), and the MCP delegation server. - Refreshed defaults table, stack-composition diagram, subpath-export table (incl. both bins), and the in-repo adoption-skill pointer. - All example links verified against examples/ (dropped the stale ones the old README pointed at; added agent-into-reviewer + self-improving-loop).
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.
Rewrites the README around the full 0.39.0 surface: anchored Table of Contents, a clean Getting started (the 20-line
handleChatTurn), a which-entry-point decision table, and a Capabilities section with a copy-pasteable example for each — driven loops + topology drivers, agent-authored dynamic topology, the delegated loop-runner (runDelegatedLoop+ theagent-runtime-loopbin), reliable build-in-a-loop gates, valid-only research (createKbGate), identity-gatedoptimizePrompt, OTel GenAI topology tracing, and the MCP delegation server. Refreshed defaults, stack diagram, subpath/bin table, adoption-skill pointer. All example links verified againstexamples/(stale ones dropped).