Rewrite README as a capability tour - #19
Open
twist900 wants to merge 1 commit into
Open
Conversation
Lead with the one-call prebuilt agent, then present each capability (crash recovery, human-in-the-loop, time travel, stream modes, long-term memory, fan-out/fan-in, node resilience, subgraphs, observability) as a short intuition-building snippet, deferring option-level detail to hexdocs and the runnable example scripts. Co-authored-by: Cursor <cursoragent@cursor.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
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.
Why
Follow-up to #17 / #18: this commit was part of #18 but was not included in the merge, so the README on
mainstill documents the pre-#17 library — the strongest new capabilities (durable execution, stream modes, prebuilt agent, long-term memory, time travel) are invisible, and a few documented facts are now stale (checkpointer behaviour callbacks, provider callbacks).What
LangEx.Prebuilt.agent/1with the outputs a reader cares about; the hand-wired loop moves to Quick Start as the "full control" path.examples/scripts.LangEx.Checkpointercallbacks now includedelete_thread/1, custom providers should implementchat_with_usage/2for usage accounting, added optional OpenTelemetry deps to Installation, license badge points at this repo.How
Documentation-only change — no code. Snippets were written against the shipped APIs (all covered by the existing test suite) and total length is 279 lines vs 263 before.
QA instructions
README.mdtop to bottom — each snippet should be understandable without opening the docs.main):Prebuilt.agent/1,LangEx.stream(..., modes: [...]),LangEx.Store.put/3,Graph.add_node/4withretry:/cache:/defer:,LangEx.get_state_history/2,Graph.to_mermaid/1.mix teststill green (docs-only, but the suite runs in CI anyway).Made with Cursor