Skip to content

docs: complete .NET operation and testing references - #303

Draft
zhongkechen wants to merge 1 commit into
mainfrom
docs/dotnet-released-reference
Draft

zhongkechen wants to merge 1 commit into
mainfrom
docs/dotnet-released-reference

Conversation

@zhongkechen

@zhongkechen zhongkechen commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

The C# operation references omit released configuration fields, incremental parallel branches, custom subtype rules, and local checkpoint-token omission. Complete those references for Core 2.2.0 and Testing 1.1.0, and correct the documented handling of successful step results whose serialization or round-trip deserialization fails.

Scope

  • Complete the operation-specific configuration signatures and parameter descriptions for steps, callbacks, child contexts, invokes, map, parallel, and polling.
  • Document CreateParallel, typed branch handles, per-branch serializers, deterministic registration, and failed/skipped branch behavior. Add a separate incremental-branch example while retaining the existing named-branch example.
  • Document custom subtype validation and replay stability for steps, callbacks, and child contexts.
  • Document terminal StepException behavior for serialization and round-trip failures, including replay without repeating the successful step body.
  • Document OmitCheckpointToken on the local TestRunnerOptions only.

Related PRs

Merge checks against #279, #280, #284, and #300 each pass without conflicts.

Validation

  • Zensical 0.0.40 clean build, full-site Markdown formatting/spelling, hidden-character checks, vendored-asset integrity checks, and git diff --check passed.
  • All 688 example files are referenced. Local links and anchors passed across the nine changed rendered pages.
  • Every retained file matches its previously validated content. The retained runnable C# examples compiled against Core 2.2.0 and Testing 1.1.0; focused runtime checks covered incremental branches and terminal serialization-failure replay. No SDK implementation changed.

Cloud integration and full cross-SDK conformance were not run. Browser visual preview was unavailable under the local-file URL policy; generated HTML was checked directly.

@zhongkechen
zhongkechen deployed to ai-pr-review-runtime October 28, 2026 22:02 — with GitHub Actions Active
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
zhongkechen marked this pull request as draft October 28, 2026 22:17
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.
@zhongkechen zhongkechen changed the title docs: refresh .NET serializer and operation references docs: complete .NET operation and testing references Oct 28, 2026
@zhongkechen
zhongkechen force-pushed the docs/dotnet-released-reference branch from 311e9f0 to b0991e7 Compare October 28, 2026 22:19

This branch is waiting to be deployed

1 failed (outdated) and 1 waiting deployments
ai-pr-review — b0991e7e Waiting Oct 28, 2026 by zhongkechen via ai-pr-review / Approve AI PR review #161
ai-pr-review-runtime — 38964968 Deployed Oct 28, 2026 by zhongkechen via ai-pr-review / Codex review / Generate Codex review #157
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant