Repository navigation
docs: catch up docs with runs.list status arrays, Nest defaults, and attribute limits - #4206
Merged
Merged
Conversation
…attribute limits
Document the array form of `runs.list({ status })` (#3707) in the World
storage reference and the World authoring guide, correct the `preloadBundles`
default for `WorkflowModule` on Vercel (#3695), and surface the 8KiB
`attr_set` write limit (#4082) on the attributes guide.
Co-Authored-By: Claude Fable 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>
🦋 Changeset detectedLatest commit: 2331b7b The changes in this PR will be included in the next version bump. This PR includes changesets to release 16 packages
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 |
Contributor
Contributor
Sim WorldSimulated world deterministic testing for races. Traces 🟠 world-sim scenario book — 1 fail of 41 total
Full trace: |
VaguelySerious
approved these changes
Sep 16, 2026
Contributor
|
No backport to All three doc updates describe behavior that exists only on To override, re-run the Backport to stable workflow manually via |
This was referenced Sep 16, 2026
VaguelySerious
added a commit
that referenced
this pull request
Sep 20, 2026
#4206 landed a longer cell for `params.status` on main while this branch carried its own. Adopt main's, so the merge that follows is a fast, conflict-free catch-up. Co-Authored-By: Peter Wielander <29887157+VaguelySerious@users.noreply.github.com>
This branch was successfully deployed
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 free
to 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.
Description
Docs cleanup for functionality that merged in the last day without (complete) docs changes:
runs.list({ status })accepts an array (Allow runs.list({ status }) to accept an array #3707): theruns.list()reference table now listsworkflowNameandstatus, including array/any-match and empty-array semantics and theworld-vercelsingle-status restriction. The World authoring guide gets a matching "Run listing" implementation note. Also adds the missingpendingstatus to theWorkflowRuntype table.preloadBundlesdefault ([nest] Harden the NestJS integration for production #3695): the reference, getting-started page, and@workflow/nestREADME saidtrue; the code defaults tofalsewhenVERCELis set. Also clarifies theskipBuilddefault in the getting-started config sample.attr_setwrite limit ([core] Enforce the 8KiB attribute event-data limit before writes #4082): the limit was documented on thesetAttributesreference page only; the attributes observability guide now mentions it next to the other attribute limits.Docs Preview
runs.list()WorkflowModule›WorkflowModuleOptionsAll edits are v5-only (
@workflow/world4.x still takes a singlestatus, and the Nest options are new in 5.x), so there are no v4 pages to compare.How did you test your changes?
Docs-only.
pnpm test:docsinpackages/docs-typecheckpasses for every edited page (remaining local failures are pre-existing@workflow/vitest/world-simsamples that need those packages built), and the Docs Code Samples / Docs Links / Docs Preview Smoke Checks CI jobs are green. Verified each section above renders on the preview deployment.PR Checklist - Required to merge
pnpm changesetwas run to create a changelog for this PR (patch for@workflow/nest, whose README changed)git commit --signoffon your commits)@vercel/workflowin a comment once the PR is ready, and the above checklist is complete🤖 Generated with Claude Code