Skip to content

Commit 136c1f4

Browse files
[docs] Tidy world API docs and document new stream helpers (#1581)
1 parent 7e33c62 commit 136c1f4

File tree

13 files changed

+581
-1128
lines changed

13 files changed

+581
-1128
lines changed

docs/content/docs/api-reference/workflow-api/get-world.mdx

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -39,23 +39,17 @@ showSections={["returns"]}
3939
The World object provides access to several entity interfaces. See the [World SDK](/docs/api-reference/workflow-api/world) reference for complete documentation:
4040

4141
<Cards>
42-
<Card href="/docs/api-reference/workflow-api/world/runs" title="world.runs">
43-
List, filter, and inspect workflow runs.
42+
<Card href="/docs/api-reference/workflow-api/world/storage" title="Storage">
43+
Query runs, steps, hooks, and the underlying event log.
4444
</Card>
45-
<Card href="/docs/api-reference/workflow-api/world/steps" title="world.steps">
46-
List and inspect step execution data.
47-
</Card>
48-
<Card href="/docs/api-reference/workflow-api/world/hooks" title="world.hooks">
49-
Look up hooks by ID or token.
50-
</Card>
51-
<Card href="/docs/api-reference/workflow-api/world/events" title="world.events">
52-
Query the append-only event log.
53-
</Card>
54-
<Card href="/docs/api-reference/workflow-api/world/streams" title="world.streams">
45+
<Card href="/docs/api-reference/workflow-api/world/streams" title="Streams">
5546
Read, write, and manage data streams.
5647
</Card>
57-
<Card href="/docs/api-reference/workflow-api/world/queue" title="world.queue">
58-
Enqueue runs and create queue handlers.
48+
<Card href="/docs/api-reference/workflow-api/world/queue" title="Queue">
49+
Low-level queue dispatch (internal SDK infrastructure).
50+
</Card>
51+
<Card href="/docs/api-reference/workflow-api/world/observability" title="Observability">
52+
Hydrate step I/O, parse display names, decrypt data.
5953
</Card>
6054
</Cards>
6155

docs/content/docs/api-reference/workflow-api/world/events.mdx

Lines changed: 0 additions & 227 deletions
This file was deleted.

0 commit comments

Comments
 (0)