docs: realtime streams v2 (#2673)

Author: ericallam

docs/docs.json

@@ -10,7 +10,11 @@
   },
   "favicon": "/images/favicon.png",
   "contextual": {
-    "options": ["copy", "view", "claude"]
+    "options": [
+      "copy",
+      "view",
+      "claude"
+    ]
   },
   "navigation": {
     "dropdowns": [
@@ -36,7 +40,11 @@
             "pages": [
               {
                 "group": "Tasks",
-                "pages": ["tasks/overview", "tasks/schemaTask", "tasks/scheduled"]
+                "pages": [
+                  "tasks/overview",
+                  "tasks/schemaTask",
+                  "tasks/scheduled"
+                ]
               },
               "triggering",
               "runs",
@@ -51,7 +59,12 @@
               "errors-retrying",
               {
                 "group": "Wait",
-                "pages": ["wait", "wait-for", "wait-until", "wait-for-token"]
+                "pages": [
+                  "wait",
+                  "wait-for",
+                  "wait-until",
+                  "wait-for-token"
+                ]
               },
               "queue-concurrency",
               "versioning",
@@ -60,6 +73,7 @@
               "runs/max-duration",
               "tags",
               "runs/metadata",
+              "tasks/streams",
               "run-usage",
               "context",
               "runs/priority",
@@ -99,7 +113,9 @@
           },
           {
             "group": "Development",
-            "pages": ["cli-dev"]
+            "pages": [
+              "cli-dev"
+            ]
           },
           {
             "group": "Deployment",
@@ -111,7 +127,10 @@
               "deployment/atomic-deployment",
               {
                 "group": "Deployment integrations",
-                "pages": ["github-integration", "vercel-integration"]
+                "pages": [
+                  "github-integration",
+                  "vercel-integration"
+                ]
               }
             ]
           },
@@ -167,11 +186,20 @@
           },
           {
             "group": "MCP Server",
-            "pages": ["mcp-introduction", "mcp-tools", "mcp-agent-rules"]
+            "pages": [
+              "mcp-introduction",
+              "mcp-tools",
+              "mcp-agent-rules"
+            ]
           },
           {
             "group": "Using the Dashboard",
-            "pages": ["run-tests", "troubleshooting-alerts", "replaying", "bulk-actions"]
+            "pages": [
+              "run-tests",
+              "troubleshooting-alerts",
+              "replaying",
+              "bulk-actions"
+            ]
           },
           {
             "group": "Troubleshooting",
@@ -193,19 +221,30 @@
               "self-hosting/kubernetes",
               {
                 "group": "Environment variables",
-                "pages": ["self-hosting/env/webapp", "self-hosting/env/supervisor"]
+                "pages": [
+                  "self-hosting/env/webapp",
+                  "self-hosting/env/supervisor"
+                ]
               },
               "open-source-self-hosting"
             ]
           },
-
           {
             "group": "Open source",
-            "pages": ["open-source-contributing", "github-repo", "changelog", "roadmap"]
+            "pages": [
+              "open-source-contributing",
+              "github-repo",
+              "changelog",
+              "roadmap"
+            ]
           },
           {
             "group": "Help",
-            "pages": ["community", "help-slack", "help-email"]
+            "pages": [
+              "community",
+              "help-slack",
+              "help-email"
+            ]
           }
         ]
       },
@@ -226,7 +265,10 @@
           },
           {
             "group": "Tasks API",
-            "pages": ["management/tasks/trigger", "management/tasks/batch-trigger"]
+            "pages": [
+              "management/tasks/trigger",
+              "management/tasks/batch-trigger"
+            ]
           },
           {
             "group": "Runs API",
@@ -272,7 +314,9 @@
         "groups": [
           {
             "group": "Introduction",
-            "pages": ["guides/introduction"]
+            "pages": [
+              "guides/introduction"
+            ]
           },
           {
             "group": "Frameworks",
@@ -401,7 +445,9 @@
           },
           {
             "group": "Migration guides",
-            "pages": ["migration-mergent"]
+            "pages": [
+              "migration-mergent"
+            ]
           },
           {
             "group": "Community packages",
@@ -422,7 +468,10 @@
     "href": "https://trigger.dev"
   },
   "api": {
-    "openapi": ["openapi.yml", "v3-openapi.yaml"],
+    "openapi": [
+      "openapi.yml",
+      "v3-openapi.yaml"
+    ],
     "playground": {
       "display": "simple"
     }

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

@@ -44,6 +44,10 @@ This demo is a full stack example that uses the following:
   - The `AnthropicEval` component: [src/components/evals/Anthropic.tsx](https://github.com/triggerdotdev/examples/blob/main/batch-llm-evaluator/src/components/evals/Anthropic.tsx)
   - The `XAIEval` component: [src/components/evals/XAI.tsx](https://github.com/triggerdotdev/examples/blob/main/batch-llm-evaluator/src/components/evals/XAI.tsx)
   - The `OpenAIEval` component: [src/components/evals/OpenAI.tsx](https://github.com/triggerdotdev/examples/blob/main/batch-llm-evaluator/src/components/evals/OpenAI.tsx)
-- Each of these components then uses [useRealtimeRunWithStreams](/realtime/react-hooks/streams) to subscribe to the different LLM responses.
+- Each of these components then uses [useRealtimeRunWithStreams](/realtime/react-hooks/streams#userealtimerunwithstreams) to subscribe to the different LLM responses.
+
+<Note>
+  This example uses the older `useRealtimeRunWithStreams` hook. For new projects, consider using the new [`useRealtimeStream`](/realtime/react-hooks/streams#userealtimestream-recommended) hook (SDK 4.1.0+) for a simpler API and better type safety with defined streams.
+</Note>
 
 <RealtimeLearnMore />

docs/realtime/backend/overview.mdx

@@ -14,7 +14,11 @@ There are three main categories of functionality:
 
 - **[Subscribe functions](/realtime/backend/subscribe)** - Subscribe to run updates using async iterators
 - **[Metadata](/realtime/backend/subscribe#subscribe-to-metadata-updates-from-your-tasks)** - Update and subscribe to run metadata in real-time
-- **[Streams](/realtime/backend/streams)** - Emit and consume real-time streaming data from your tasks
+- **[Streams](/realtime/backend/streams)** - Read and consume real-time streaming data from your tasks
+
+<Note>
+  To learn how to emit streams from your tasks, see our [Realtime Streams](/tasks/streams) documentation.
+</Note>
 
 ## Authentication