Repository navigation
docs: refresh Java, TypeScript, and Python references - #300
Open
zhongkechen wants to merge 4 commits into
Open
zhongkechen wants to merge 4 commits into
zhongkechen wants to merge 4 commits into
Conversation
zhongkechen
had a problem deploying
to
ai-pr-review-runtime
October 27, 2026 20:35 — with 
GitHub Actions
Failure
GitHub Actions
Failure
zhongkechen
had a problem deploying
to
ai-pr-review-runtime
October 27, 2026 20:35 — with
GitHub Actions
Failure
GitHub Actions
Failure
zhongkechen
changed the title
zhongkechen
had a problem deploying
to
ai-pr-review-runtime
October 27, 2026 21:45 — with
GitHub Actions
Failure
GitHub Actions
Failure
zhongkechen
had a problem deploying
to
ai-pr-review-runtime
October 27, 2026 21:45 — with
GitHub Actions
Failure
GitHub Actions
Failure
SilanHe
self-requested a review
October 28, 2026 19:44
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
SilanHe
reviewed
Oct 28, 2026
SilanHe
reviewed
Oct 28, 2026
SilanHe
reviewed
Oct 28, 2026
yaythomas
requested changes
Oct 28, 2026
Contributor
Author
I'll split C#/.Net doc updates into separate PRs and let @GarrettBeatty handle them |
Update Java, TypeScript, and Python references for released serialization, plugin factories, telemetry, operation, and testing APIs. Keep .NET changes in a separate pull request. Validate review feedback against released SDK source. Fix Python invoke registration, plugin failure timing, hook snippets, telemetry details, and shared filesystem guidance. Keep migration notes in the upgrade summaries. Run formatting, spelling, example-reference and generated-HTML checks, plus a clean Zensical build. Compile the eight TypeScript hook snippets and run focused TypeScript and Python behavior checks.
zhongkechen
force-pushed
the
docs/refresh-released-sdk-reference
branch
from
October 28, 2026 22:01
4c3768b to
b6aa899
Compare
zhongkechen
had a problem deploying
to
ai-pr-review-runtime
October 28, 2026 22:01 — with
GitHub Actions
Failure
GitHub Actions
Failure
zhongkechen
had a problem deploying
to
ai-pr-review-runtime
October 28, 2026 22:01 — with
GitHub Actions
Failure
GitHub Actions
Failure
zhongkechen
changed the title
zhongkechen
added a commit
that referenced
this pull request
Oct 28, 2026
Clarify null defaults and per-branch serializer precedence in one place. Remove repeated filesystem constructor guidance and restore spacing in the examples after removing redundant comments. Recheck the C# feedback carried from PR #300 into PR #303. Documentation quality checks, example references, the clean site build, and generated HTML links pass. Example changes contain only whitespace.
zhongkechen
added a commit
that referenced
this pull request
Oct 28, 2026
Document missing operation config signatures, incremental parallel branches, custom subtype rules, terminal serializer failures, and local checkpoint-token omission for Core 2.2.0 and Testing 1.1.0. Leave the serialization guide and its examples to PRs #279 and #280. Keep shared prose and other language updates in PR #300. All remaining Markdown changes are inside C# tabs; no file overlaps #279 or #280. Validate formatting, spelling, snippets, vendored assets, rendered links, and a clean Zensical build. Retained examples match the previously compiled and runtime-checked versions.
This was referenced Oct 28, 2026
SilanHe
reviewed
Oct 29, 2026
yaythomas
requested changes
Oct 29, 2026
Describe pause and resume, subtype comparisons, and early completion in terms of current behavior. Keep migration steps in the upgrade guide. Make ESLint guidance easier to find and link to the current plugin README for configuration details.
Restore TypeScript and Python path, preview, and default-serdes guidance. Qualify Java callback and invoke requirements and describe current APIs. Remove the incorrect S3 Files durability warning and release-bound prose.
Remove release-specific installation and migration text from the reference pages. Clarify invocation trace headers, chained-invoke parenting, plugin factory validation, and hook waiting semantics. Link Powertools logging to the shared execution metadata reference and remove confusing fallback trace and memory attribute details.
zhongkechen
had a problem deploying
to
ai-pr-review-runtime
October 29, 2026 01:42 — with
GitHub Actions
Failure
GitHub Actions
Failure
zhongkechen
had a problem deploying
to
ai-pr-review-runtime
October 29, 2026 01:42 — with
GitHub Actions
Failure
GitHub Actions
Failure
This branch had an error being deployed
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.
The reference pages still register plugin instances rejected by SDK 3, label Java filesystem serialization as unavailable, and omit released operation and testing APIs. Update the Java, TypeScript, and Python references and examples for the releases through October 26, 2026.
The changes cover per-invocation plugin factories, Java context-aware and filesystem serialization, OpenTelemetry setup and trace behavior, telemetry exporter/MCP APIs, custom subtypes, batch results, and local testing controls. Review corrections include Python invoke-target registration by name, TypeScript plugin-load failure timing and class-method snippets, precise filesystem storage modes, named Java provider interfaces and fatal errors, and the telemetry write-access result and prompt lifecycle.
Scope and related PRs
docs: add SDK 3 upgrade summaries #298 contains the SDK 3 upgrade summaries, including the TypeScript Testing SDK peer-range and OpenTelemetry memory-unit migration notes. Those migration notes are not repeated in the reference sections here.
.NET serialization guidance and examples belong to docs(csharp): document the per-operation serializer override (Step/Callback/Invoke/WaitForCondition/ChildContext + Map/Parallel ItemSerializer) #279/docs(csharp): document the .NET FileSystem serializer (#2540) #280. The 11 reopened .NET review threads remain outstanding there; docs: complete .NET operation and testing references #303 covers operation/testing references and does not change the serialization guide or examples.
Validation
FAILEDon every invocation before the handler runs and verify filesystemundefined/nulland overflow round trips.Noneand overflow round trips.git diff --checkpassed. Validation harnesses remain outside the PR.Generated HTML and the browser DOM were inspected directly. Chromium loaded the localhost preview but produced blank screenshots, so visual screenshot verification was unavailable. No SDK implementation changed. Cloud integration and full cross-SDK conformance were not run.