Skip to content

[docs] Catch up docs with recently shipped SDK changes - #5094

Open
pranaygp wants to merge 2 commits into
mainfrom
workflow-docs-cleanup-tue-27-oct
Open

pranaygp wants to merge 2 commits into
mainfrom
workflow-docs-cleanup-tue-27-oct

Conversation

@pranaygp

@pranaygp pranaygp commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Catches the docs up with SDK changes that shipped in the last day without docs updates.

Change Source PR Docs edit
Postgres World keyed jobs keep their first scheduled run time, so a duplicate publish can't erase a delayed retry's backoff #5053 One sentence on the job queue in the Postgres World's How it works section, and the matching requirement in the Building a World queue checklist so custom Worlds keep the same guarantee
Local World stream readers get each chunk once, in the order it was written #5069 streams.get() in the Streams API reference states the ordering guarantee, and the Building a World Streamer section lists it as a requirement

I reviewed the other PRs from the last day and they need no further docs. Length-prefixed abort stream frames (#5081), encrypted abort previews in the Streams viewer (#5079), closing abort reads cancelled while connecting (#5041), forwarding the run public key on a resilient run_started (#5070), the single-flight skipped-winner fix (#5053), and the more detailed v4 createEvent error (#5072) are internal or bug fixes that don't change documented behavior. The world-testing and CI changes (#5073, #5085) aren't user-facing. The Workflows pages in vercel/front don't cover any of these, so they need no change.

Docs Preview

Page Preview
Postgres World How it works
Building a World Implementation considerations, Streamer interface
Streams API reference get()

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Pranay Prakash <1797812+pranaygp@users.noreply.github.com>

Co-Authored-By: Pranay Prakash <1797812+pranaygp@users.noreply.github.com>
@pranaygp
pranaygp requested a review from a team as a code owner October 27, 2026 16:05
Copilot AI balanced review requested due to automatic review settings October 27, 2026 16:05
@vercel

vercel Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Deployment Actions Updated
example-nextjs-workflow-turbopack Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC
example-nextjs-workflow-webpack Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC
example-workflow Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC
workbench-astro-workflow Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC
workbench-express-workflow Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC
workbench-fastify-workflow Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC
workbench-hono-workflow Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC
workbench-nestjs-workflow Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC
workbench-nitro-workflow Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC
workbench-nuxt-workflow Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC
workbench-python-workflow Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC
workbench-sveltekit-workflow Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC
workbench-tanstack-start-workflow Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC
workbench-vite-workflow Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC
workflow-docs Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC
workflow-swc-playground Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC
workflow-tarballs Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC
workflow-web Ready Ready Preview, v0 Oct 27, 2026 4:11pm UTC

Copilot AI left a comment

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.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

@changeset-bot

changeset-bot Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1cce715

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Pranay Prakash <1797812+pranaygp@users.noreply.github.com>

Co-Authored-By: Pranay Prakash <1797812+pranaygp@users.noreply.github.com>
@github-actions

github-actions Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Sim World

Simulated world deterministic testing for races. Traces

🟢 world-sim scenario book — 0 fail of 44 total

fence=per-spec

scenario outcome events virt replay violations
✅ smoke-no-steps completed 3 0ms ok 0
✅ smoke-one-step completed 6 0ms ok 0
✅ hook-at-step-started completed 11 0ms ok 0
✅ hook-at-step-completed completed 11 0ms ok 0
✅ hook-at-hook-created completed 11 0ms ok 0
✅ claim-hook-at-registration completed 11 0ms ok 0
✅ claim-hook-at-step-started completed 11 0ms ok 0
✅ deadline-hook-wins completed 6 1.0h ok 0
✅ deadline-expires completed 6 1.0h ok 0
✅ step-vs-timer-early-settlement completed 8 1.0h ok 0
✅ long-sleep completed 11 30.0d ok 0
✅ hook-never-arrives stalled 3 0ms skipped 0
✅ step-retries-twice completed 10 2.0s ok 0
✅ parallel-steps completed 9 0ms ok 0
✅ hook-on-execution-state completed 11 0ms ok 0
✅ peek-hook-before-branch completed 11 0ms ok 0
✅ peek-hook-after-branch completed 11 0ms ok 0
✅ peek-hook-at-registration completed 11 0ms ok 0
✅ race-hook-before-probe completed 11 0ms ok 0
✅ race-hook-after-probe completed 11 0ms ok 0
✅ race-duplicate-delivery completed 12 0ms ok 0
✅ attr-hook-before-step completed 10 0ms ok 0
✅ attr-hook-after-step completed 10 0ms ok 0
✅ attr-from-step-body completed 12 0ms ok 0
✅ fork-hook-after-timeout completed 13 1.0m ok 0
✅ fork-hook-before-timeout completed 13 1.0m ok 0
✅ count-hook-after-timeout completed 16 1.0m ok 0
✅ count-hook-before-timeout completed 19 1.0m ok 0
✅ stale-read-step-count-fork completed 19 1.0m ok 0
✅ stale-read-equal-step-counts completed 13 1.0m ok 0
✅ step-vs-step-fork completed 12 0ms ok 0
✅ step-vs-step-fork-fenced completed 12 0ms ok 0
✅ fence-catches-benign-direction completed 12 5ms ok 0
✅ in-flight-before-decision completed 16 1.0m ok 0
✅ in-flight-before-decision-counted completed 16 1.0m ok 0
✅ in-flight-after-decision completed 18 2.0m ok 0
✅ stale-read-step-count-fork-fenced completed 19 1.0m ok 0
✅ fork-hook-wins completed 12 1.0m ok 0
✅ fork-timeout-wins completed 12 1.0m ok 0
✅ unclaimed-payload-under-fork completed 16 1.0m ok 0
✅ claimed-payload-under-fork completed 16 1.0m ok 0
✅ writers-independent-step-bodies completed 12 0ms ok 0
✅ writers-scripted-tempo completed 11 0ms ok 0
✅ cancel-mid-step cancelled 7 0ms skipped 0

Full trace: world-sim.txt

This branch was successfully deployed

1 active deployment
Preview – workflow-docs — 1cce715e Deployed Oct 27, 2026 by vercel[bot]
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