docs: re-read README, Quickstart, Concepts against v0.6.0#55
Merged
Conversation
Editorial pass after the 0.6.x feature wave. - README: grammar fix on the engine-features sentence; Next-steps Concepts/Examples bullets updated to include the 0.6.x topics (parallel branches, LLMs, prompts) and link to docs/examples rather than the GitHub directory. - Quickstart: Concepts and Examples link lists refreshed (was missing parallel-branches/llms/prompts/checkpointing; said "five demos" with ten now shipped). - concepts/index: added Prompts; expanded llms and checkpointing blurbs. - concepts/graphs: added the four 0.6.x builder methods (add_fan_out_node, add_parallel_branches_node, with_checkpointer, with_state_migration) to the methods list. - concepts/composition: appended a "Related composition primitives" section pointing at fan-out and parallel-branches. - concepts/fan-out: switched code samples to the canonical builder.add_fan_out_node(...) API. - concepts/parallel-branches, observability: em-dash sweep. - concepts/llms: new Tool calling section between Structured output and Content blocks; refreshed example links to point at docs/examples instead of the GitHub repo. state-and-reducers, checkpointing, and prompts pages audited and left untouched (already accurate against v0.6.x).
There was a problem hiding this comment.
Pull request overview
Editorial re-read of public docs against v0.6.0: README/Quickstart next-steps refreshed, concepts index expanded with prompts/checkpointing/multimodal, graphs.md lists new builder methods, composition gets a related-primitives section, fan-out switches to the canonical builder API, and parallel-branches/observability/llms have em-dash sweeps plus a new Tool calling section.
Changes:
- README + Quickstart next-steps lists refreshed to match the 0.6.x concept/example surface and link to
docs/examples. - Concepts pages updated: index adds Prompts, graphs.md lists four new builder methods, composition gains "Related composition primitives", fan-out uses
builder.add_fan_out_node(...), llms.md adds a Tool calling section. - Em-dash sweep across
parallel-branches.mdandobservability.md.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Grammar fix and refreshed Next-steps Concepts/Examples bullets. |
| docs/getting-started/index.md | Quickstart Next list updated to 0.6.x concepts and local examples link. |
| docs/concepts/index.md | Added Prompts; expanded LLMs and Checkpointing blurbs. |
| docs/concepts/graphs.md | Added four new builder methods to the list. |
| docs/concepts/composition.md | New "Related composition primitives" section. |
| docs/concepts/fan-out.md | Switched samples to builder.add_fan_out_node(...). |
| docs/concepts/parallel-branches.md | Em-dash replacements. |
| docs/concepts/observability.md | Em-dash replacements. |
| docs/concepts/llms.md | New Tool calling section; example links point to docs/examples. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
Third of the docs-phase PRs. Editorial re-read of the public docs surface against the 0.6.x feature set, after Examples (PR #54) and the site UX pass (PR #53). No source changes.
docs/examplesrather than the GitHub directory.add_fan_out_node,add_parallel_branches_node,with_checkpointer,with_state_migration) to the methods list.FanOutNode(name=..., config=FanOutConfig(...))form to the canonicalbuilder.add_fan_out_node(...)API the examples use.## Tool callingsection between Structured output and Content blocks; refreshed bottom-of-page references to link intodocs/examplesinstead of the GitHub repo.Audited and left untouched (already accurate against v0.6.x, no em dashes):
state-and-reducers.md,checkpointing.md,prompts.md.Test plan
uv run --group docs mkdocs build --strictsucceedsconcepts/llms.mdrenders the new Tool calling section between Structured output and Content blocks; code block and cross-link to example 09 workconcepts/graphs.mdlists the four new builder methods in the methods bullet list, each with a cross-link to its dedicated pageconcepts/composition.mdends with the new "Related composition primitives" section linking to fan-out and parallel-branchesconcepts/fan-out.mdcode samples showbuilder.add_fan_out_node(...)rather thanFanOutNode(name=...)concepts/parallel-branches.mdandconcepts/observability.mdfor prose flow after em-dash replacements