Skip to content

Add Workflow Streams docs for the Java SDK#4888

Open
brianstrauch wants to merge 1 commit into
mainfrom
java-workflow-streams
Open

Add Workflow Streams docs for the Java SDK#4888
brianstrauch wants to merge 1 commit into
mainfrom
java-workflow-streams

Conversation

@brianstrauch

@brianstrauch brianstrauch commented Jul 15, 2026

Copy link
Copy Markdown
Member

What was changed

Adds a Workflow Streams feature guide for the Java SDK, mirroring the existing Python, TypeScript, and Go pages.

  • New page: docs/develop/java/workflows/workflow-streams.mdx, covering enabling a stream (WorkflowStream.newInstance in @WorkflowInit), publishing from Workflows and clients/Activities, subscribing, Continue-As-New rollovers, the deduplication window, best practices, and the LLM token-streaming example.
  • Documents both Java subscriber APIs: the blocking iterator (WorkflowStreamSubscription) and the non-blocking listener (WorkflowStreamListener / WorkflowStreamSubscriptionHandle), which is unique to the Java SDK.
  • Wires the page into sidebars.js, the Java SDK index pages, and the encyclopedia page's per-SDK cross-links.

Content is sourced from the temporal-workflowstreams contrib module (sdk-java v1.37.0) and the samples-java workflow streams scenarios.

Why?

Workflow Streams docs existed for Python, TypeScript, and Go but not Java, even though the Java contrib module shipped in SDK v1.37.0.

🤖 Generated with Claude Code

┆Attachments: EDU-6721 Add Workflow Streams docs for the Java SDK

Mirrors the Python, TypeScript, and Go feature guides, sourced from the
temporal-workflowstreams contrib module (sdk-java v1.37.0) and samples-java.
Includes the Java-specific non-blocking listener subscriber API alongside
the blocking iterator, and wires the page into the sidebar, Java index
pages, and encyclopedia cross-links.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@brianstrauch brianstrauch requested a review from a team as a code owner July 15, 2026 17:59
@vercel

vercel Bot commented Jul 15, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
temporal-documentation Ready Ready Preview, Comment Jul 15, 2026 6:00pm

Request Review

/>
</RelatedReadContainer>

## How Workflow Streams works

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'How Workflow Streams works' should use sentence-style capitalization.

@github-actions

Copy link
Copy Markdown
Contributor

📖 Docs PR preview links

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