Skip to content

Commit b6d97e7

Browse files
committed
Improved overview
1 parent 048ec36 commit b6d97e7

File tree

1 file changed

+5
-19
lines changed

1 file changed

+5
-19
lines changed

docs/realtime/overview.mdx

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Realtime overview
33
sidebarTitle: Overview
4-
description: Using the Trigger.dev Realtime API to trigger and subscribe to runs in real-time.
4+
description: Using the Trigger.dev Realtime API to trigger and/or subscribe to runs in real-time.
55
---
66

77
import RealtimeExamplesCards from "/snippets/realtime-examples-cards.mdx";
@@ -12,7 +12,7 @@ Trigger.dev Realtime allows you to trigger, subscribe to, and get real-time upda
1212

1313
All Realtime subscriptions require authentication so you can securely trigger and subscribe to runs. See our [authentication guide](/realtime/auth) for more details.
1414

15-
## How run subscriptions work
15+
## What you can do with Realtime
1616

1717
You can subscribe to real-time updates for different scopes of runs:
1818

@@ -21,12 +21,12 @@ You can subscribe to real-time updates for different scopes of runs:
2121
- **Batch runs** - All runs within a specific batch
2222
- **Trigger + subscribe combos** - Trigger a task and immediately subscribe to its run (frontend only)
2323

24-
Once subscribed, you'll receive the complete [run object](/realtime/run-object) with automatic real-time updates whenever the run changes, including:
24+
Once subscribed, you'll receive the complete [run object](/realtime/run-object) with automatic real-time updates whenever the [run changes](/realtime/how-it-works#run-changes), including:
2525

2626
- **Status changes** - queued → executing → completed, etc.
27-
- **Metadata updates** - Custom progress tracking, status updates, user data, etc. ([backend](/realtime/backend/metadata) | [React hooks](/realtime/react-hooks/realtime#using-metadata))
27+
- **Metadata updates** - Custom progress tracking, status updates, user data, etc. ([React hooks](/realtime/react-hooks/subscribe#using-metadata) | [backend](/realtime/backend/metadata))
2828
- **Tag changes** - When [tags](/tags) are added or removed from the run
29-
- **Stream data** - Real-time data chunks from your tasks, perfect for AI/LLM streaming ([backend](/realtime/backend/streams) | [React hooks](/realtime/react-hooks/streams))
29+
- **Stream data** - Real-time data chunks from your tasks, perfect for AI/LLM streaming ([React hooks](/realtime/react-hooks/streams) | [backend](/realtime/backend/streams))
3030

3131
## Realtime approaches
3232

@@ -41,17 +41,3 @@ Use our React hooks to build real-time UIs that update as runs execute. Ideal fo
4141
Use our server-side SDK to subscribe to runs from your backend code, other tasks, or serverless functions. Perfect for triggering workflows, sending notifications, or updating databases based on run status changes.
4242

4343
**[See our Backend guide](/realtime/backend)**
44-
45-
## Realtime demo
46-
47-
<iframe
48-
width="100%"
49-
height="315"
50-
src="https://www.youtube.com/embed/RhJAbSGkS88?si=4Z72SfygeklNI3As"
51-
title="YouTube video player"
52-
allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
53-
referrerPolicy="strict-origin-when-cross-origin"
54-
allowFullScreen
55-
/>
56-
57-
<RealtimeExamplesCards />

0 commit comments

Comments
 (0)