vercel[bot] 57dce98fe4 [docs] Ship the World pages in the bundle, and fix two stale claims
The run-limit guidance added here hangs off `/worlds/vercel#per-run-limits`,
and the skill sends agents to `node_modules/workflow/docs/`. But
`docs/content/worlds/` is a sibling of `docs/content/docs/`, so
`packages/workflow`'s prepack never copied it: every `/worlds/...` link in the
bundled pages was a dead end for an agent, including the hub this guidance
points at. Copy `worlds/v5` into `docs/worlds/` and list it in the skill's
documentation-structure map.

Two claims contradicted pages this PR already touches:

- `child-workflows.mdx` opened by calling a 500-child spawn practical, while
  its own Tips and its "chunked spawning" section say to start them in chunks
  of 10-50. Point the bullet at that section.
- `whats-new.mdx` said the event ceiling can be tuned "as a fallback", but
  `runtime-tuning.mdx` states that `WORKFLOW_MAX_EVENTS` does not override the
  Vercel World's service-owned value. Scope the claim to the Worlds where it
  is true.

Guard: assert prepack copies the worlds tree and the skill lists it, and
extend the anchor check to same-page `(#anchor)` jumps. Both fail when the
change is reverted.

Co-Authored-By: Claude Opus 5 <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>
2026-09-13 01:29:28 +00:00
2025-10-23 12:07:52 +03:00
2025-10-23 12:07:52 +03:00
2025-10-23 12:07:52 +03:00
2026-02-05 16:19:16 -08:00
2025-10-23 12:07:52 +03:00
2025-10-23 12:07:52 +03:00

Workflow SDK logo

Workflow SDK

Vercel logo npm version License Join the community on GitHub

Workflow SDK makes TypeScript and JavaScript functions durable. It persists workflow progress, retries failed steps, and provides built-in observability. Workflows can suspend without using compute while they wait.

Quick start

Install the SDK in an existing project:

npm install workflow

Configure the integration for your framework. For example, with Next.js:

// next.config.ts
import { withWorkflow } from 'workflow/next';

export default withWorkflow({});

Then start a workflow from an API route, Server Action, or other server-side code:

import { start } from 'workflow/api';
import { onboardUser } from './workflows/onboard-user';

await start(onboardUser, ['hello@example.com']);

Run your app, then open the local observability UI in another terminal:

npm run dev
npx workflow web

Choose your framework in the getting-started guides.

Note

The workflow package includes its full documentation, so coding agents can read version-matched guides locally from node_modules/workflow/docs.

Run anywhere

Local development uses the bundled backend with no configuration. Deploy to Vercel for managed storage, queuing, scaling, and observability. To self-host, use the Postgres backend or implement a custom World.

The Worlds page lists maintainer-curated third-party Worlds, including self-hosted and managed options. Submit your World by updating the Worlds Manifest.

Community

The Workflow SDK community lives on GitHub Discussions, where you can ask questions, share ideas, and show what you have built.

Contributing

Contributions are welcome. Use issues and discussions to collaborate with the team and wider community. By participating, you agree to our Code of Conduct.

Security

If you find a security vulnerability in Workflow SDK, disclose it responsibly instead of opening a public issue.

To participate in our Open Source Software Bug Bounty program, please email responsible.disclosure@vercel.com. We will add you to the program and provide further instructions for submitting your report.

S
Description
workflow: Creates durable, resumable workflows using Vercel's Workflow SDK. Use when building workflows that need to survive restarts, pause for external events, retry…; workflow-init: Install and configure Vercel Workflow SDK before it exists in node_modules. Use when the user asks to "install workflow", "set up workflow", "add durable…
Readme 140 MiB
Languages
TypeScript 88.8%
JavaScript 5.9%
Rust 4%
CSS 0.5%
Python 0.4%
Other 0.3%