Skip to content

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

Closed
pranaygp wants to merge 1 commit into
mainfrom
workflow-docs-cleanup-thu-15-oct
Closed

pranaygp wants to merge 1 commit into
mainfrom
workflow-docs-cleanup-thu-15-oct

Conversation

@pranaygp

Copy link
Copy Markdown
Contributor

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

Change Source PR Docs edit
The web UI recommends the QuickJS VM with snapshotting on runs that failed with MAX_EVENTS_EXCEEDED or REPLAY_TIMEOUT, and the run sidebar shows the run's Workflow VM #4874 The two error pages say the web UI shows the recommendation, and the eligibility rules in max-events-exceeded point at the Workflow VM attribute
The Postgres World writes each event in the same transaction as its row change, and heals waits left without their wait_completed #4882, #4883 New Troubleshooting section on the Postgres World page with the query from the package README that finds steps stuck by earlier versions, and how to recover them. Neither PR changed the docs site

I reviewed the other PRs from the last day and they need no further docs: the timestamp-with-time-zone migration (#4757) and the pool connection-error handling (#4812) updated the Postgres World page themselves, and dropping the nanoid dependency (#4335) is a security fix with no behavior change.

The vercel/front Workflows pages need nothing for these changes. The Vercel dashboard doesn't render the new run-limit guidance yet, and the event-limit note for the pricing page is already open in vercel/front#91076.

Docs Preview

Page Preview
Postgres World Troubleshooting
max-events-exceeded Error message and Run on the QuickJS VM with snapshotting
replay-timeout Error message

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.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 15, 2026 16:05
@vercel

vercel Bot commented Oct 15, 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 15, 2026 4:09pm UTC
example-nextjs-workflow-webpack Ready Ready Preview, v0 Oct 15, 2026 4:09pm UTC
example-workflow Ready Ready Preview, v0 Oct 15, 2026 4:09pm UTC
workbench-astro-workflow Ready Ready Preview, v0 Oct 15, 2026 4:09pm UTC
workbench-express-workflow Ready Ready Preview, v0 Oct 15, 2026 4:09pm UTC
workbench-fastify-workflow Ready Ready Preview, v0 Oct 15, 2026 4:09pm UTC
workbench-hono-workflow Ready Ready Preview, v0 Oct 15, 2026 4:09pm UTC
workbench-nestjs-workflow Ready Ready Preview, v0 Oct 15, 2026 4:09pm UTC
workbench-nitro-workflow Ready Ready Preview, v0 Oct 15, 2026 4:09pm UTC
workbench-nuxt-workflow Ready Ready Preview, v0 Oct 15, 2026 4:09pm UTC
workbench-python-workflow Ready Ready Preview, v0 Oct 15, 2026 4:09pm UTC
workbench-sveltekit-workflow Ready Ready Preview, v0 Oct 15, 2026 4:09pm UTC
workbench-tanstack-start-workflow Ready Ready Preview, v0 Oct 15, 2026 4:09pm UTC
workbench-vite-workflow Ready Ready Preview, v0 Oct 15, 2026 4:09pm UTC
workflow-docs Ready Ready Preview, v0 Oct 15, 2026 4:09pm UTC
workflow-swc-playground Ready Ready Preview, v0 Oct 15, 2026 4:09pm UTC
workflow-tarballs Ready Ready Preview, v0 Oct 15, 2026 4:09pm UTC
workflow-web Ready Ready Preview, v0 Oct 15, 2026 4:09pm UTC

Copilot AI balanced review requested due to automatic review settings October 15, 2026 16:05

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 reached their quota limit.

@changeset-bot

changeset-bot Bot commented Oct 15, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 71d34f1

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

@github-actions

Copy link
Copy Markdown
Contributor

Sim World

Simulated world deterministic testing for races. Traces

🟢 world-sim scenario book — 0 fail of 42 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 12 0ms ok 0
✅ hook-at-step-completed completed 12 0ms ok 0
✅ hook-at-hook-created completed 12 0ms ok 0
✅ deadline-hook-wins completed 7 1.0h ok 0
✅ deadline-expires completed 7 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 12 0ms ok 0
✅ peek-hook-before-branch completed 12 0ms ok 0
✅ peek-hook-after-branch completed 12 0ms ok 0
✅ peek-hook-at-registration completed 12 0ms ok 0
✅ race-hook-before-probe completed 12 0ms ok 0
✅ race-hook-after-probe completed 12 0ms ok 0
✅ race-duplicate-delivery completed 13 0ms ok 0
✅ attr-hook-before-step completed 11 0ms ok 0
✅ attr-hook-after-step completed 11 0ms ok 0
✅ attr-from-step-body completed 13 0ms ok 0
✅ fork-hook-after-timeout completed 14 1.0m ok 0
✅ fork-hook-before-timeout completed 14 1.0m ok 0
✅ count-hook-after-timeout completed 17 1.0m ok 0
✅ count-hook-before-timeout completed 20 1.0m ok 0
✅ stale-read-step-count-fork completed 20 1.0m ok 0
✅ stale-read-equal-step-counts completed 14 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 17 1.0m ok 0
✅ in-flight-before-decision-counted completed 17 1.0m ok 0
✅ in-flight-after-decision completed 19 2.0m ok 0
✅ stale-read-step-count-fork-fenced completed 20 1.0m ok 0
✅ fork-hook-wins completed 13 1.0m ok 0
✅ fork-timeout-wins completed 13 1.0m ok 0
✅ unclaimed-payload-under-fork completed 17 1.0m ok 0
✅ claimed-payload-under-fork completed 17 1.0m ok 0
✅ writers-independent-step-bodies completed 12 0ms ok 0
✅ writers-scripted-tempo completed 12 0ms ok 0
✅ cancel-mid-step cancelled 7 0ms skipped 0

Full trace: world-sim.txt

@VaguelySerious

Copy link
Copy Markdown
Member

current set of changes is not worth documenting

This branch was successfully deployed

1 active deployment
Preview – workflow-docs — 71d34f16 Deployed Oct 15, 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.

3 participants