Uh oh!
There was an error while loading. Please reload this page.
Conversation
…orkflow/observability The API reference is organized as one section per package entry point, but getWorld() and the World SDK pages lived under workflow/api despite being exported from workflow/runtime, and the observability utilities page documented workflow/observability exports from inside the World SDK group. - Add workflow-runtime section (getWorld, World SDK) with an index that also covers the remaining runtime exports - Promote observability utilities to a top-level workflow-observability page matching its import path - Update all inbound links, add permanent redirects for the old URLs in both /docs and /v5/docs spaces, and mirror the structure in v4 - Update workflow skill doc paths (bump to 1.9) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Contributor
Contributor
📊 Benchmark Results
workflow with no steps💻 Local Development
▲ Production (Vercel)
workflow with 1 step💻 Local Development
▲ Production (Vercel)
workflow with 10 sequential steps💻 Local Development
▲ Production (Vercel)
workflow with 25 sequential steps💻 Local Development
▲ Production (Vercel)
workflow with 50 sequential steps💻 Local Development
▲ Production (Vercel)
Promise.all with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
Promise.all with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
Promise.all with 50 concurrent steps💻 Local Development
▲ Production (Vercel)
Promise.race with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
Promise.race with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
Promise.race with 50 concurrent steps💻 Local Development
▲ Production (Vercel)
workflow with 10 sequential data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
workflow with 25 sequential data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
workflow with 50 sequential data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
workflow with 10 concurrent data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
workflow with 25 concurrent data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
workflow with 50 concurrent data payload steps (10KB)💻 Local Development
▲ Production (Vercel)
Stream Benchmarks(includes TTFB metrics)workflow with stream💻 Local Development
▲ Production (Vercel)
stream pipeline with 5 transform steps (1MB)💻 Local Development
▲ Production (Vercel)
10 parallel streams (1MB each)💻 Local Development
▲ Production (Vercel)
fan-out fan-in 10 streams (1MB each)💻 Local Development
▲ Production (Vercel)
SummaryFastest Framework by WorldWinner determined by most benchmark wins
Fastest World by FrameworkWinner determined by most benchmark wins
Column Definitions
Worlds:
❌ Some benchmark jobs failed:
Check the workflow run for details. |
Contributor
🧪 E2E Test Results✅ All tests passed Summary
Details by Category✅ ▲ Vercel Production
✅ 💻 Local Development
✅ 📦 Local Production
✅ 🐘 Local Postgres
✅ 🪟 Windows
✅ 📋 Other
|
Contributor
There was a problem hiding this comment.
Pull request overview
Reorganizes the API reference docs so pages live under the section that matches their actual public entrypoints (workflow/runtime for getWorld + World SDK, and workflow/observability for observability utilities), with redirects and link updates to prevent breakage.
Changes:
- Adds new
workflow/runtimeAPI reference section (v4 + v5) and moves World SDK docs under it. - Promotes observability utilities into a dedicated
workflow/observabilityAPI reference page/section and updates all inbound links. - Adds permanent redirects for the moved routes and updates
skills/workflow/SKILL.mdto reflect the new doc structure/version.
Reviewed changes
Copilot reviewed 32 out of 32 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| skills/workflow/SKILL.md | Bumps skill version and updates the documented docs path map to the new API reference layout. |
| docs/next.config.ts | Adds permanent redirects for moved API reference routes (World SDK + observability + getWorld). |
| docs/content/docs/v5/foundations/versioning.mdx | Updates observability utility link to the new top-level page. |
| docs/content/docs/v5/foundations/streaming.mdx | Updates World SDK streams link to the new workflow-runtime location. |
| docs/content/docs/v5/api-reference/workflow-runtime/world/streams.mdx | Adjusts prerequisites/related links to point at the new getWorld + storage pages. |
| docs/content/docs/v5/api-reference/workflow-runtime/world/storage.mdx | Updates observability links to the new workflow-observability page. |
| docs/content/docs/v5/api-reference/workflow-runtime/world/queue.mdx | Updates prerequisite and related storage link to workflow-runtime. |
| docs/content/docs/v5/api-reference/workflow-runtime/world/meta.json | Adds nav metadata for the World SDK subsection. |
| docs/content/docs/v5/api-reference/workflow-runtime/world/index.mdx | Updates cards/links to workflow-runtime and points observability to the new page. |
| docs/content/docs/v5/api-reference/workflow-runtime/meta.json | Adds nav metadata for the new workflow/runtime section. |
| docs/content/docs/v5/api-reference/workflow-runtime/index.mdx | Adds overview page for workflow/runtime and lists key exports. |
| docs/content/docs/v5/api-reference/workflow-runtime/get-world.mdx | Updates World SDK/observability references to new routes. |
| docs/content/docs/v5/api-reference/workflow-observability.mdx | Renames/repositions page to represent workflow/observability entrypoint and updates links. |
| docs/content/docs/v5/api-reference/workflow-api/world/meta.json | Removes old World SDK nav metadata from workflow/api section. |
| docs/content/docs/v5/api-reference/workflow-api/index.mdx | Removes getWorld/World SDK cards and adds callout pointing to workflow/runtime. |
| docs/content/docs/v5/api-reference/meta.json | Adds workflow-runtime and workflow-observability to API reference navigation. |
| docs/content/docs/v5/api-reference/index.mdx | Adds cards for the new workflow/runtime and workflow/observability sections. |
| docs/content/docs/v4/foundations/versioning.mdx | Updates observability utility link to the new top-level page. |
| docs/content/docs/v4/foundations/streaming.mdx | Updates World SDK streams link to the new workflow-runtime location. |
| docs/content/docs/v4/api-reference/workflow-runtime/world/streams.mdx | Adjusts prerequisites/related links to point at the new getWorld + storage pages. |
| docs/content/docs/v4/api-reference/workflow-runtime/world/storage.mdx | Updates observability links to the new workflow-observability page. |
| docs/content/docs/v4/api-reference/workflow-runtime/world/queue.mdx | Updates prerequisite and related storage link to workflow-runtime. |
| docs/content/docs/v4/api-reference/workflow-runtime/world/meta.json | Adds nav metadata for the World SDK subsection. |
| docs/content/docs/v4/api-reference/workflow-runtime/world/index.mdx | Updates cards/links to workflow-runtime and points observability to the new page. |
| docs/content/docs/v4/api-reference/workflow-runtime/meta.json | Adds nav metadata for the new workflow/runtime section. |
| docs/content/docs/v4/api-reference/workflow-runtime/index.mdx | Adds overview page for workflow/runtime and lists key exports (incl. stepEntrypoint() for v4). |
| docs/content/docs/v4/api-reference/workflow-runtime/get-world.mdx | Updates World SDK/observability references to new routes. |
| docs/content/docs/v4/api-reference/workflow-observability.mdx | Renames/repositions page to represent workflow/observability entrypoint and updates links. |
| docs/content/docs/v4/api-reference/workflow-api/world/meta.json | Removes old World SDK nav metadata from workflow/api section. |
| docs/content/docs/v4/api-reference/workflow-api/index.mdx | Removes getWorld/World SDK cards and adds callout pointing to workflow/runtime. |
| docs/content/docs/v4/api-reference/meta.json | Adds workflow-runtime and workflow-observability to API reference navigation. |
| docs/content/docs/v4/api-reference/index.mdx | Adds cards for the new workflow/runtime and workflow/observability sections. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…ion pages, typecheck coverage - docs-typecheck: map workflow/runtime, workflow/next, all framework adapter entry points, @workflow/serde, @workflow/vitest, @workflow/world, and pin vite/vitest/nitro-vite to single instances. Unmapped imports were silently unchecked (TS2307 ignored), which had been hiding real sample errors. - workflow/observability: split into per-function pages (hydrateResourceIO, observabilityRevivers, hydrateData, parseStepName, parseWorkflowName, parseClassName). Removed the encryption section that documented non-existent exports (getEncryptionKeyForRun is a World method; hydrateResourceIOWithKey doesn't exist) behind @expect-error markers. - workflow/runtime: dedicated pages for createWorld, setWorld, getWorldHandlers, workflowEntrypoint, healthCheck (+ stepEntrypoint on v4). v4 pages note the 4.x sync getWorld/createWorld behavior. - workflow/errors: pages for the 5 undocumented exports: WorkflowError, HookConflictError, WorkflowRunNotCompletedError, WorkflowRuntimeError, RunNotSupportedError. - New API reference sections for all framework adapters: workflow/nitro, workflow/nuxt, workflow/sveltekit, workflow/astro, workflow/vite, workflow/nest (v4 variants reflect stable's API: no sourcemap option, no-arg sveltekit/astro plugins). - Removed stale escape hatches: 6 @skip-typecheck in vitest docs, 3 @expect-error:2351 in serde docs — all now type-check for real. - Fixed how-it-works/encryption.mdx sample to satisfy the getEncryptionKeyForRun overload set; fixed get-world.mdx to import parseWorkflowName from workflow/observability instead of the internal @workflow/utils path. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
karthikscale3
approved these changes
Jun 12, 2026
karthikscale3
left a comment
Contributor
There was a problem hiding this comment.
Reviewed for correctness and regressions — LGTM.
What I checked:
- API accuracy: Verified every documented export against sources on both branches. v5: all
workflow/runtimeexports exist with matching signatures,getWorldis async,stepEntrypointcorrectly absent; allworkflow/observabilityfunctions,workflow/errorsclasses (incl. theWorkflowError.is()subclass caveat), and adapter exports match. v4 (againststable):getWorldis sync, no-arg sveltekit/astro plugins, nosourcemapoption, and theparseWorkflowNameimport fix toworkflow/observabilityis correct. ConfirmedgetEncryptionKeyForRunis only an optionalWorldmethod andhydrateResourceIOWithKeydoesn't exist — removing those docs was right. - Redirects: All 8 rules correct; exact-match observability rules precede the
world/:path*catch-alls, no existing rule shadows them, no redirect chains. - Stale links: Grep for
workflow-api/world/workflow-api/get-worldacross docs, app code, and skills found nothing outside the redirect rules. - Lockfile churn: Beyond adding
viteto docs-typecheck, the install re-resolvedradix-uilatest(1.4.3 → 1.5.0, docs app) and shifted an esbuild peer resolution in@nuxt/module-builder's build graph — dev/build-time only, and Build Packages + all E2E suites pass. - CI: Green except
Benchmark Vercel (nextjs-turbopack), which is unrelated — one bench case returnedNaNxagainst the Vercel deployment while the same suite passed on Local/Postgres variants. A re-run should clear it.
🤖 Generated with Claude Code
Uh oh!
There was an error while loading. Please reload this page.
github-actionsBot
added a commit
that referenced
this pull request
Jun 12, 2026
…orkflow/observability (#2375) Signed-off-by: Pranay Prakash <pranay.gp@gmail.com>
Contributor
Backport PR opened against |
pranaygp added a commit
that referenced
this pull request
Jun 12, 2026
…ry-2 * origin/main: Version Packages (beta) (#2364) Animate in-progress segments in the timeline (#2383) Render queued span time as a lead-in connector on the trace timeline. (#2381) fix(docs): right-align sidebar folder carets consistently (#2377) [core] Add wire-level framing for byte streams (#1853) docs: move World SDK and getWorld under workflow/runtime, split out workflow/observability (#2375) Replace hook.hasConflict with hook.getConflict() returning the conflicting Run (#2373) ci: use claude-fable-5 for backport AI model (#2370) Add `hook.hasConflict` for early hook conflict detection (#2015) [core] V2: unify wait+step queue dispatch in suspension processing (#1925) fix(world-local,world-postgres): make duplicate hook_created idempotent (#2295) docs(observability): remove MVP implementation detail bullet (#2367) fix: settle aborted parallel steps before completing abortParallelWorkflow (#2244)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two commits restructuring and correcting the API reference so it follows one convention everywhere: one section per package entry point, one page per export, with every documented export verified against package sources and every code sample actually type-checked.
1. Restructure:
workflow/runtime+workflow/observabilitysectionsThe API reference is organized by entry point, but
getWorld()and the World SDK pages lived underworkflow/apidespite being exported fromworkflow/runtime— the pages' own examples import fromworkflow/runtime. The observability utilities additionally documentedworkflow/observabilityexports from inside the World SDK group.workflow-runtimesection:get-world, World SDK (world/— storage, streams, queue), plus dedicated pages for every other runtime export:createWorld,setWorld,getWorldHandlers,workflowEntrypoint,healthCheck(+stepEntrypointon v4 only — verified againststable).workflow-observabilitysection with per-function pages:hydrateResourceIO,observabilityRevivers,hydrateData,parseStepName,parseWorkflowName,parseClassName./docsand/v5/docsspaces; all inbound links updated.2. Correctness sweep (every documented export verified against sources)
getEncryptionKeyForRun()andhydrateResourceIOWithKey()asworkflow/observabilityexports behind@expect-error:2305markers — neither exists there (getEncryptionKeyForRunis an optional method on theWorldinterface;hydrateResourceIOWithKeydoesn't exist anywhere). Replaced with an honest "Encrypted Data" section describing the pass-throughUint8Arraybehavior.workflow/errorsexports got pages:WorkflowError(incl. the.is()doesn't-match-subclasses caveat),HookConflictError,WorkflowRunNotCompletedError,WorkflowRuntimeError,RunNotSupportedError.getWorld()returnsPromise<World>— it's synchronous in 4.x (became async in 5.x); noted on the v4 pages withawait-compatible samples.parseWorkflowNameimport fixed from internal@workflow/utils/parse-nametoworkflow/observability.how-it-works/encryption.mdxsample that didn't satisfy theWorld["getEncryptionKeyForRun"]overload set.3. Coverage: framework adapter sections
workflow/nextwas the only documented adapter. Added sections for all six others, with v4 variants reflecting stable's actual API (nosourcemapoption; no-arg sveltekit/astro plugins):workflow/nitro,workflow/nuxt,workflow/sveltekit(workflowPlugin()),workflow/astro(workflow()),workflow/vite(workflow()),workflow/nest(WorkflowModule,NestLocalBuilder,WorkflowController,configureWorkflowController).4. Docs typechecking: closed the silent-skip hole
@workflow/docs-typecheckignores module-not-found errors for import paths missing from itspathsmapping — so samples importingworkflow/runtime,workflow/next,@workflow/serde,@workflow/vitest, or@workflow/worldwere silently unchecked (everything typedany). Fixed by mapping all entry points (plus pinningvite/vitest/nitro/viteto single instances to avoid duplicate-package type conflicts).This immediately surfaced and led to fixing: the encryption.mdx sample bug, the vite getting-started
nitroconfig-key augmentation, and made 12 previously-skipped samples genuinely type-check — all 6@skip-typecheckmarkers in the vitest docs and all 3 stale@expect-error:2351markers in the serde docs are gone. Remaining markers all have honest reasons (type-only signature snippets, v4-only exports checked against v5 types, polyfilled globals).Result: 997 samples type-check (up from 919), 0 failures. Docs build (684 pages), link lint, and smoke test all pass. No changeset needed (docs content, skills, and a private package).
Docs Preview
Preview deployment: workflow-docs-git-pgp-docs.vercel.sh (requires Vercel team access)
workflow/runtimeindexworkflow/observabilityindexworkflow/nitro(new)workflow/nuxt(new)workflow/sveltekit(new)workflow/astro(new)workflow/vite(new)workflow/nest(new)workflow/apiindexRedirect check: old World SDK URL and old observability URL should land on the new pages.
🤖 Generated with Claude Code