Skip to content

[docs] Tidy world API docs and document new stream helpers #1581

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VaguelySerious merged 4 commits into from
Apr 2, 2026
Merged

[docs] Tidy world API docs and document new stream helpers #1581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
21f688a
[docs] Tidy world API docs and document new stream helpers
VaguelySerious Apr 1, 2026
09fa2cd
fix: address review comments on world API doc examples
VaguelySerious Apr 2, 2026
dfba78f
update
VaguelySerious Apr 2, 2026
6fa72c5
Fix: The "Cancelling Runs" section links to a deleted page `/docs/api…
vercel[bot] Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 8 additions & 14 deletions docs/content/docs/api-reference/workflow-api/get-world.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,23 +39,17 @@ showSections={["returns"]}
The World object provides access to several entity interfaces. See the [World SDK](/docs/api-reference/workflow-api/world) reference for complete documentation:

<Cards>
<Card href="/docs/api-reference/workflow-api/world/runs" title="world.runs">
List, filter, and inspect workflow runs.
<Card href="/docs/api-reference/workflow-api/world/storage" title="Storage">
Query runs, steps, hooks, and the underlying event log.
</Card>
<Card href="/docs/api-reference/workflow-api/world/steps" title="world.steps">
List and inspect step execution data.
</Card>
<Card href="/docs/api-reference/workflow-api/world/hooks" title="world.hooks">
Look up hooks by ID or token.
</Card>
<Card href="/docs/api-reference/workflow-api/world/events" title="world.events">
Query the append-only event log.
</Card>
<Card href="/docs/api-reference/workflow-api/world/streams" title="world.streams">
<Card href="/docs/api-reference/workflow-api/world/streams" title="Streams">
Read, write, and manage data streams.
</Card>
<Card href="/docs/api-reference/workflow-api/world/queue" title="world.queue">
Enqueue runs and create queue handlers.
<Card href="/docs/api-reference/workflow-api/world/queue" title="Queue">
Low-level queue dispatch (internal SDK infrastructure).
</Card>
<Card href="/docs/api-reference/workflow-api/world/observability" title="Observability">
Hydrate step I/O, parse display names, decrypt data.
</Card>
</Cards>

Expand Down
227 changes: 0 additions & 227 deletions docs/content/docs/api-reference/workflow-api/world/events.mdx
View file
Open in desktop

This file was deleted.

Loading
Loading