Uh oh!
There was an error while loading. Please reload this page.
docs: document multi-region support in the Vercel World - #2895
Conversation
The Vercel World Limitations section still described the backend as
iad1-only, which is no longer true — it now runs in every Vercel
Function region, with each run pinned to a single region at creation.
- Replace the single-region / iad1 data-residency limitations with a
Multi-region section: automatic pinning from the creating function's
region (single- and multi-region deployments), explicit per-run
selection via start(..., { region }), routing semantics for readers,
and 4.x/pre-existing-run behavior (iad1, no migration).
- Version requirement called out as workflow 5.x beta with a TODO to
pin the exact minimum version once released; 4.x will not support
region pinning.
- Limitations now lists the one that remains: a run's region is fixed
at creation (no migration).
- /docs/deploying: add a Multi-region bullet to the Vercel World
feature list, deferring details to /worlds/vercel.
|
Uh oh!
There was an error while loading. Please reload this page.
…lacement
The start({ region }) option pins where the run's data is stored and
where its queue messages dispatch from; it does not deploy code.
Execution happens in the regions the application is deployed to, so
region-local execution requires deploying the app to the desired
region (vercel.json regions or the project's Function Regions
setting). Adds a warning callout to the explicit-selection section and
tightens the intro to only claim region-local execution for the
automatic case.Same fix as v5: the v4 Deploying sidebar only listed 'Building a World', leaving the world pages reachable only via the /worlds/:id routes with no sidebar path. Adds the Worlds group (Vercel World, Postgres World, Local World) between the section index and Building a World, and pluralizes the group title. Verified via dev server: the group renders, and the sidebar items land on /worlds/:id through the existing permanent redirects (same v4 content).
#1981 merged; the first release carrying multi-region support is 5.0.0-beta.33. Replace the '5.x (currently in beta)' placeholders (and the TODO marker) with the exact minimum version on all four touched pages (v5 world page + deploying bullet, v4 breadcrumb callouts).
There was a problem hiding this comment.
Pull request overview
Updates the documentation to reflect multi-region support in the Vercel World, aligning v4/v5 docs with the new region-pinned run model introduced in workflow 5.0.0-beta.33+.
Changes:
- Adds a new “Multi-region” section to the v5 Vercel World page and removes stale iad1-only limitations.
- Updates v4 docs to clarify multi-region is a 5.x feature and that 4.x remains iad1-only.
- Adjusts Deploying section navigation and adds a multi-region bullet/link from the Deploying landing pages.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/content/docs/v5/deploying/world/vercel-world.mdx | Adds multi-region model, automatic/explicit pinning guidance, and updated limitations. |
| docs/content/docs/v5/deploying/world/meta.json | Renames section title from “World” → “Worlds”. |
| docs/content/docs/v5/deploying/meta.json | Adds the world subsection to Deploying nav. |
| docs/content/docs/v5/deploying/index.mdx | Adds multi-region feature bullet and links to the new v5 Vercel World section. |
| docs/content/docs/v4/deploying/world/vercel-world.mdx | Adds callout pointing to v5 multi-region docs; scopes limitations explicitly to 4.x. |
| docs/content/docs/v4/deploying/world/meta.json | Renames section title from “World” → “Worlds”. |
| docs/content/docs/v4/deploying/meta.json | Adds the world subsection to Deploying nav. |
| docs/content/docs/v4/deploying/index.mdx | Adds informational callout pointing to v5 multi-region docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Hook tokens carry no region information, so the token-to-run mapping behind getHookByToken()/resumeHook() is currently stored in iad1 for every run regardless of its region. Hook payloads are unaffected — a received payload lands on the run's event log in the run's region like all other run data. Noted as potentially becoming a project-level setting in the future.
- /docs/deploying multi-region bullet: 'execution' -> 'queuing'; the region option pins data/queue/streams, while execution follows the app's deployed regions (matching the v4 callout and the world page's own warning callout) - v5 world page: drop 'region is fixed for its entire lifetime' from the Good to know bullet — the Limitations section already owns that statement; the bullet now covers only routing semantics
No backport to This commit documents a 5.x-only feature (Vercel World multi-region, requiring To override, re-run the Backport to stable workflow manually via |
What
Updates the docs for Vercel World multi-region support (#1981):
/worlds/vercel(primary content):start(workflow, args, { region: "sfo1" })/docs/deploying: adds a Multi-region bullet to the Vercel World feature list, deferring details to/worlds/vercel.Version
#1981 has merged 🎉 — all pages now state the exact requirement:
workflow5.0.0-beta.33 or later for multi-region support (4.x will not gain it).Notes:
start()'s API reference pullsStartOptionsvia TSDoc from package types, so theregionoption self-documents there once [core][world][world-vercel] AddWorld.createRunId()and region-aware queue routing #1981's types ship — no manual edit neededset-attributespage export error — verified identical on main, unrelated to these pages