docs: refresh README for v3.4 orchestration + v3.3 cluster runtime#61
Merged
Conversation
- Replace the stale 'What's new in 3.2/3.0' block with 'What's new in 3.4/3.3' (programmable orchestration grammar + cluster-grade runtime), deferring older notes to CHANGELOG. - Fix SessionRetentionLimits SDK examples: both SDKs support it today (Python retention_limits dict, Node retentionLimits object) — drop the false 'Rust-only / SDK shape lands later' claims. - Fix the Node setBudgetGuard example to the real single-ctx-object callback signature (camelCase usage keys, optional timeoutMs, the fail-closed + must-not-throw napi notes).
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.
What
Refreshes
README.mdto match the shipped v3.4.0 (programmable orchestration) and v3.3.0 (cluster-grade runtime) releases, and fixes three factual defects in the existing SDK examples.Changes
What's new in 3.2 / 3.0block with What's new in 3.4 / 3.3:AgentStepSpec/StepOutcomecontracts over theAgentExecutorseam,execute_steps_parallel/execute_pipeline/execute_steps_parallel_resumable+WorkflowCheckpoint, schema-forced output, and thesession.parallel/pipeline/parallelResumableSDK grammar.close/is_closed/list_sessions), identity labels,BudgetGuard, loop checkpoints +resume_run,SessionRetentionLimits, MCP idle disconnect.Factual fixes
retention_limitsdict, NoderetentionLimitsobject).setBudgetGuard— corrected from the wrong two-positional-arg form to the real single-ctx-object callbacks (camelCaseusagekeys, optionaltimeoutMs, fail-closed + must-not-throw notes). The Python example was already correct and is unchanged.Docs-only; no code changes. Accompanying
apps/docschapters (en + cn) updated separately in the monorepo.