docs: guide to running Workflow Builder diagrams on Temporal - #157
Open
dawidaksamski wants to merge 3 commits into
Open
dawidaksamski wants to merge 3 commits into
dawidaksamski wants to merge 3 commits into
Conversation
dawidaksamski
added this pull request to stack #158
September 17, 2026 09:26
dawidaksamski
force-pushed
the
feat/WB-531-workflow-builder-temporal-guide
branch
from
September 21, 2026 16:20
4112961 to
4eb0d4d
Compare
dawidaksamski
marked this pull request as ready for review
September 21, 2026 16:36
dawidaksamski
requested review from
librowski,
lukasz-jazwa,
piotrblaszczyk and
szymon-t-sc
as code owners
September 21, 2026 16:36
dawidaksamski
force-pushed
the
feat/WB-531-workflow-builder-temporal-guide
branch
from
September 22, 2026 16:10
7895b30 to
d86f589
Compare
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.
Guide: Using Workflow Builder with Temporal
Adds
apps/docs/src/content/docs/guides/temporal.mdxand one screenshot. The page walks through the@workflowbuilder/temporalintegration file by file, proves it with a single run, and hands the reader the complete code as the runnable sample inexamples/workflow-builder-temporal, fetched withnpx degit.The shape follows Temporal's own integration pages: understand the integration, see one run, download the code. It is about 2,300 words of prose and 270 lines of code, against roughly 2,500 words and 900 lines in the first draft of this branch.
What the page keeps is the part an integration reviewer cares about: the diagram-to-Workflow-Execution and node-to-Activity model, the
workflows.tsre-export and why the bundler forces it, the executor registry as a mapped type with access to the attempt number and retry control through error classes, the snapshot-to-definition mapper that is the only glue between the canvas and the plugin, and what a run looks like in Event History, including node labels as activity Summaries and the retry recorded asattempt: 2withlastFailure.Every snippet labelled with a sample path is a verbatim excerpt of that file or a deletions-only subset of it, so the page and the folder the reader downloads cannot disagree. Three snippets diverge deliberately and say so in the prose.
Two files, no other workspace touched.
Base branch
Targets
feat/WB-532-temporal-code-exchange-sampleon purpose. The page's first actionable step isnpx degitagainstexamples/workflow-builder-temporal, which is not onmainyet, so the sample has to land first. The docs site deploys by hand fromrelease, so the published page never carries the dead link.How it was verified
pnpm build:docspasses locally: 209 pages, with the guide and its screenshot emitted. The Docs build check also passes on CI for this branch.temporal-sampleCI job, and its runtime behaviour was verified when it landed: a full run against a local Temporal server, the deliberate retry in Event History, the bridge over HTTP and the editor driven in headless Chromium.Review pass
A review of the finished page found 13 factual defects, all fixed here. The ones worth naming:
emitEventactivity rather than leaving no trace.createRunWorkflowalone is applied; it is a map given to the plugin alone that leaves every node on the default.Not in this PR