Skip to content

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

Merged
VaguelySerious merged 1 commit into
mainfrom
workflow-docs-cleanup-mon-19-oct
Oct 19, 2026
Merged

VaguelySerious merged 1 commit into
mainfrom
workflow-docs-cleanup-mon-19-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
New Connecting from outside a deployment guide on the Vercel World page #3989 The two pages people land on when they hit this from the other side now point at it. start()'s deploymentId: "latest" callout said external callers authenticate with VERCEL_TOKEN; the SDK actually prefers the World's explicit token and only falls back to VERCEL_TOKEN (same on stable), which is what the new guide tells readers to pass. The Observability page's Vercel backend section only covered vercel login; it now says what to set without one (such as in CI) and links the guide. Applied to v4 and v5.

#3989 was the only change on main since the last docs catch-up (#4904, still open, covers #4757), and it documented itself on the Vercel World and configuration pages; this only fills in the cross-references it missed.

Docs Preview

Page v5 v4
start(): deploymentId: "latest" callout /docs/api-reference/workflow-api/start /v4/docs/api-reference/workflow-api/start
Observability: Vercel backend /docs/observability#vercel-backend /v4/docs/observability#vercel-backend

🤖 Generated with Claude Code

…ng from outside a deployment

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 19, 2026 16:05
Copilot AI balanced review requested due to automatic review settings October 19, 2026 16:05
@changeset-bot

changeset-bot Bot commented Oct 19, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: b413822

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

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.

@vercel

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

@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

Copy link
Copy Markdown
Contributor Author

Checked all four sections on the preview: each new link goes to its own version's Vercel World page (/worlds/vercel#… for v5, /v4/worlds/vercel#… for v4), and both target anchors exist on both pages.

@VaguelySerious
VaguelySerious merged commit a3f53cf into main Oct 19, 2026
66 checks passed
@VaguelySerious
VaguelySerious deleted the workflow-docs-cleanup-mon-19-oct branch October 19, 2026 18:57
@github-actions

Copy link
Copy Markdown
Contributor

No backport to stable for a3f53cf (AI decision).

The commit's substance is cross-referencing a new "Connecting from outside a deployment" guide that only exists on main: docs/content/worlds/ is entirely absent from origin/stable, so the added links would be dead in the docs content bundled from that branch. The one genuinely corrective piece is the start() callout sentence about deploymentId: "latest" preferring the World's token over VERCEL_TOKEN, which is also wrong on stable (at docs/content/docs/api-reference/workflow-api/start.mdx, a different path than the v4/v5 files touched here) and could be split out and forced through if desired.

To override, re-run the Backport to stable workflow manually via workflow_dispatch and paste this commit SHA into the ref input:

a3f53cf22a2e97c91363faaffa274a5fbef7c174

This branch was successfully deployed

1 active deployment
Preview – workflow-docs — b413822d Deployed Oct 19, 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