Skip to content

Commit a8202ed

Browse files
committed
Fixing links like zelda
1 parent 129f089 commit a8202ed

File tree

7 files changed

+10
-14
lines changed

7 files changed

+10
-14
lines changed

docs/guides/example-projects/batch-llm-evaluator.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ This demo is a full stack example that uses the following:
3939
- View the Trigger.dev task code in the [src/trigger/batch.ts](https://github.com/triggerdotdev/examples/blob/main/batch-llm-evaluator/src/trigger/batch.ts) file.
4040
- The `evaluateModels` task uses the `batch.triggerByTaskAndWait` method to distribute the task to the different LLM models.
4141
- It then passes the results through to a `summarizeEvals` task that calculates some dummy "tags" for each LLM response.
42-
- We use a [useRealtimeRunsWithTag](/realtime/react-hooks/realtime#userealtimerunswithtag) hook to subscribe to the different evaluation tasks runs in the [src/components/llm-evaluator.tsx](https://github.com/triggerdotdev/examples/blob/main/batch-llm-evaluator/src/components/llm-evaluator.tsx) file.
42+
- We use a [useRealtimeRunsWithTag](/realtime/react-hooks/subscribe#userealtimerunswithtag) hook to subscribe to the different evaluation tasks runs in the [src/components/llm-evaluator.tsx](https://github.com/triggerdotdev/examples/blob/main/batch-llm-evaluator/src/components/llm-evaluator.tsx) file.
4343
- We then pass the relevant run down into three different components for the different models:
4444
- The `AnthropicEval` component: [src/components/evals/Anthropic.tsx](https://github.com/triggerdotdev/examples/blob/main/batch-llm-evaluator/src/components/evals/Anthropic.tsx)
4545
- The `XAIEval` component: [src/components/evals/XAI.tsx](https://github.com/triggerdotdev/examples/blob/main/batch-llm-evaluator/src/components/evals/XAI.tsx)

docs/guides/example-projects/vercel-ai-sdk-image-generator.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import RealtimeLearnMore from "/snippets/realtime-learn-more.mdx";
1111
This demo is a full stack example that uses the following:
1212

1313
- A [Next.js](https://nextjs.org/) app using [shadcn](https://ui.shadcn.com/) for the UI
14-
- Our 'useRealtimeRun' [React hook](/realtime/react-hooks/realtime) to subscribe to the run and show updates on the frontend
14+
- Our 'useRealtimeRun' [React hook](/realtime/react-hooks/subscribe#userealtimerun) to subscribe to the run and show updates on the frontend
1515
- The [Vercel AI SDK](https://sdk.vercel.ai/docs/introduction) to [generate images](https://sdk.vercel.ai/docs/ai-sdk-core/image-generation) using OpenAI's DALL-E models
1616

1717
## GitHub repo
@@ -36,6 +36,6 @@ This demo is a full stack example that uses the following:
3636
## Relevant code
3737

3838
- View the Trigger.dev task code which generates the image using the Vercel AI SDK in [src/trigger/realtime-generate-image.ts](https://github.com/triggerdotdev/examples/tree/main/vercel-ai-sdk-image-generator/src/trigger/realtime-generate-image.ts).
39-
- We use a [useRealtimeRun](/realtime/react-hooks/realtime#userealtimerun) hook to subscribe to the run in [src/app/processing/[id]/ProcessingContent.tsx](https://github.com/triggerdotdev/examples/tree/main/vercel-ai-sdk-image-generator/src/app/processing/[id]/ProcessingContent.tsx).
39+
- We use a [useRealtimeRun](/realtime/react-hooks/subscribe#userealtimerun) hook to subscribe to the run in [src/app/processing/[id]/ProcessingContent.tsx](https://github.com/triggerdotdev/examples/tree/main/vercel-ai-sdk-image-generator/src/app/processing/[id]/ProcessingContent.tsx).
4040

4141
<RealtimeLearnMore />

docs/realtime/backend/streams.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ sidebarTitle: Streams
44
description: Emit and consume real-time streaming data from your tasks
55
---
66

7-
import RealtimeExamplesCards from "/snippets/realtime-examples-cards.mdx";
8-
97
The Streams API allows you to stream data from your tasks to the outside world in realtime using the [metadata](/runs/metadata) system. This is particularly useful for streaming LLM outputs or any other real-time data.
108

119
<Note>
@@ -351,5 +349,3 @@ export const aiStreamingWithTools = schemaTask({
351349
},
352350
});
353351
```
354-
355-
<RealtimeExamplesCards />{" "}

docs/realtime/backend/subscribe.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,8 @@ The metadata API allows you to update custom metadata on runs and receive real-t
109109

110110
<Note>
111111
For frontend applications using React, see our [React hooks metadata
112-
documentation](/realtime/react-hooks/realtime#using-metadata) for consuming metadata updates in
113-
your UI.
112+
documentation](/realtime/react-hooks/subscribe#using-metadata-to-show-progress-in-your-ui) for
113+
consuming metadata updates in your UI.
114114
</Note>
115115

116116
When you update metadata from within a task using `metadata.set()`, `metadata.append()`, or other metadata methods, all subscribers to that run will automatically receive the updated run object containing the new metadata.

docs/realtime/react-hooks/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Learn more about [generating and managing tokens in our authentication guide](/r
5858
We provide several categories of hooks:
5959

6060
- **[Triggering hooks](/realtime/react-hooks/triggering)** - Trigger tasks from your frontend application
61-
- **[Subscribe hooks](/realtime/react-hooks/realtime)** - Subscribe to runs, batches, metadata, and more
61+
- **[Subscribe hooks](/realtime/react-hooks/subscribe)** - Subscribe to runs, batches, metadata, and more
6262
- **[Streams hooks](/realtime/react-hooks/streams)** - Subscribe to real-time streams from your tasks
6363
- **[SWR hooks](/realtime/react-hooks/swr)** - Fetch data once and cache it using SWR
6464

docs/realtime/react-hooks/streams.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,4 +218,4 @@ export function MyComponent({
218218
}
219219
```
220220

221-
All other options (accessToken, baseURL, enabled, id) work the same as the other realtime hooks. See our [realtime hooks documentation](/realtime/react-hooks/realtime#common-options) for more details.
221+
All other options (accessToken, baseURL, enabled, id) work the same as the other realtime hooks.

docs/realtime/react-hooks/swr.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ description: Fetch and cache data using SWR-based hooks
77
SWR hooks use the [swr](https://swr.vercel.app/) library to fetch data once and cache it. These hooks are useful when you need to fetch data without real-time updates.
88

99
<Note>
10-
While SWR can be configured to poll for updates, we recommend using the [Realtime
11-
hooks](/realtime/react-hooks/realtime) for most use-cases due to rate-limits and the way the
12-
Trigger.dev API works.
10+
While SWR can be configured to poll for updates, we recommend using our other [Realtime
11+
hooks](/realtime/react-hooks/) for most use-cases due to rate-limits and the way the Trigger.dev
12+
API works.
1313
</Note>
1414

1515
## useRun

0 commit comments

Comments
 (0)