Skip to content

docs: add Java payload offloader - #259

Open
zhongkechen wants to merge 6 commits into
mainfrom
update-java-filesystem-serdes-docs
Open

docs: add Java payload offloader#259
zhongkechen wants to merge 6 commits into
mainfrom
update-java-filesystem-serdes-docs

Conversation

@zhongkechen

@zhongkechen zhongkechen commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Summary

  • replace the superseded Java SerDes-pipeline documentation with the dedicated PayloadOffloader design
  • document FileSystemPayloadOffloader as independent from existing custom SerDes configuration
  • add Java examples for global and per-operation offloading, storage modes, path encoding, and structured previews
  • document the dedicated payload I/O executor, retry wrapper, immutable publication, external lifecycle ownership, capability handling, and preview immutability
  • retain the existing idiomatic TypeScript and Python filesystem SerDes APIs

Related changes

Part of the Java payload-offloading stack:

Testing

  • python3 scripts/check_example_refs.py
  • git diff --check
  • CI runs Markdown formatting, spelling, example-reference, and Zensical build checks

@zhongkechen
zhongkechen deployed to ai-pr-review-runtime August 25, 2026 22:53 — with GitHub Actions Active
@zhongkechen
zhongkechen had a problem deploying to ai-pr-review-runtime August 25, 2026 22:53 — with GitHub Actions Failure
@zhongkechen
zhongkechen had a problem deploying to ai-pr-review-runtime August 25, 2026 22:53 — with GitHub Actions Failure
@zhongkechen
zhongkechen had a problem deploying to ai-pr-review-runtime August 25, 2026 23:11 — with GitHub Actions Failure
@zhongkechen
zhongkechen had a problem deploying to ai-pr-review-runtime August 25, 2026 23:11 — with GitHub Actions Failure
@zhongkechen zhongkechen self-assigned this Aug 25, 2026
@zhongkechen
zhongkechen had a problem deploying to ai-pr-review-runtime August 26, 2026 03:06 — with GitHub Actions Failure
Comment thread docs/sdk-reference/state/serialization.md Outdated
@zhongkechen zhongkechen changed the title docs: add Java filesystem SerDes docs: add Java payload offloader Sep 3, 2026
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.

2 participants