WIP realtime/frontend docs

Author: ericallam

docs/frontend/overview.mdx

@@ -0,0 +1,7 @@
+---
+title: Overview & Authentication
+sidebarTitle: Overview & Auth
+description: Using the Trigger.dev v3 API from your frontend application.
+---
+
+Install the preview package: `0.0.0-realtime-20241021152316`.

docs/frontend/react-hooks.mdx

@@ -0,0 +1,99 @@
+---
+title: React hooks
+sidebarTitle: React hooks
+description: Using the Trigger.dev v3 API from your React application.
+---
+
+## Installation
+
+Install the preview package: `0.0.0-realtime-20241021152316`.
+
+```bash
+npm install @trigger.dev/[email protected]
+```
+
+## Authentication
+
+You need to use the `TriggerAuthContext` provider to authenticate your requests.
+
+```tsx
+import { TriggerAuthContext } from "@trigger.dev/react-hooks";
+
+const App = () => {
+  return (
+    <TriggerAuthContext.Provider value={{ accessToken: "your-access-token" }}>
+      <MyComponent />
+    </TriggerAuthContext.Provider>
+  );
+};
+```
+
+## Usage
+
+### useRun
+
+The `useRun` hook allows you to fetch a run by its ID.
+
+```tsx
+import { useRun } from "@trigger.dev/react-hooks";
+
+const MyComponent = ({ runId }) => {
+  const { data, error, isLoading } = useRun(runId);
+
+  if (isLoading) return <div>Loading...</div>;
+  if (error) return <div>Error: {error.message}</div>;
+
+  return <div>Run: {data.id}</div>;
+};
+```
+
+### useRealtimeRun
+
+The `useRealtimeRun` hook allows you to subscribe to a run by its ID.
+
+```tsx
+import { useRealtimeRun } from "@trigger.dev/react-hooks";
+
+const MyComponent = ({ runId }) => {
+  const { data, error, isLoading } = useRealtimeRun(runId);
+
+  if (isLoading) return <div>Loading...</div>;
+  if (error) return <div>Error: {error.message}</div>;
+
+  return <div>Run: {data.id}</div>;
+};
+```
+
+### useRealtimeRunsWithTag
+
+The `useRealtimeRunsWithTag` hook allows you to subscribe to runs with a specific tag.
+
+```tsx
+import { useRealtimeRunsWithTag } from "@trigger.dev/react-hooks";
+
+const MyComponent = ({ tag }) => {
+  const { data, error, isLoading } = useRealtimeRunsWithTag(tag);
+
+  if (isLoading) return <div>Loading...</div>;
+  if (error) return <div>Error: {error.message}</div>;
+
+  return <div>Runs: {data.map((run) => run.id).join(", ")}</div>;
+};
+```
+
+### useRealtimeBatch
+
+The `useRealtimeBatch` hook allows you to subscribe to a batch by its ID.
+
+```tsx
+import { useRealtimeBatch } from "@trigger.dev/react-hooks";
+
+const MyComponent = ({ batchId }) => {
+  const { data, error, isLoading } = useRealtimeBatch(batchId);
+
+  if (isLoading) return <div>Loading...</div>;
+  if (error) return <div>Error: {error.message}</div>;
+
+  return <div>Batch: {data.id}</div>;
+};
+```

docs/mint.json

@@ -1,7 +1,10 @@
 {
   "$schema": "https://mintlify.com/schema.json",
   "name": "Trigger.dev",
-  "openapi": ["/openapi.yml", "/v3-openapi.yaml"],
+  "openapi": [
+    "/openapi.yml",
+    "/v3-openapi.yaml"
+  ],
   "api": {
     "playground": {
       "mode": "simple"
@@ -111,27 +114,43 @@
   "navigation": [
     {
       "group": "Getting Started",
-      "pages": ["introduction", "quick-start", "how-it-works", "upgrading-beta", "limits"]
+      "pages": [
+        "introduction",
+        "quick-start",
+        "how-it-works",
+        "upgrading-beta",
+        "limits"
+      ]
     },
     {
       "group": "Fundamentals",
       "pages": [
         {
           "group": "Tasks",
-          "pages": ["tasks/overview", "tasks/scheduled"]
+          "pages": [
+            "tasks/overview",
+            "tasks/schemaTask",
+            "tasks/scheduled"
+          ]
         },
         "triggering",
         "runs-and-attempts",
         "apikeys",
         {
           "group": "Configuration",
-          "pages": ["config/config-file", "config/extensions/overview"]
+          "pages": [
+            "config/config-file",
+            "config/extensions/overview"
+          ]
         }
       ]
     },
     {
       "group": "Development",
-      "pages": ["cli-dev", "run-tests"]
+      "pages": [
+        "cli-dev",
+        "run-tests"
+      ]
     },
     {
       "group": "Deployment",
@@ -141,7 +160,9 @@
         "github-actions",
         {
           "group": "Deployment integrations",
-          "pages": ["vercel-integration"]
+          "pages": [
+            "vercel-integration"
+          ]
         }
       ]
     },
@@ -153,7 +174,13 @@
         "errors-retrying",
         {
           "group": "Wait",
-          "pages": ["wait", "wait-for", "wait-until", "wait-for-event", "wait-for-request"]
+          "pages": [
+            "wait",
+            "wait-for",
+            "wait-until",
+            "wait-for-event",
+            "wait-for-request"
+          ]
         },
         "queue-concurrency",
         "versioning",
@@ -167,13 +194,23 @@
         "context"
       ]
     },
+    {
+      "group": "Frontend usage",
+      "pages": [
+        "frontend/overview",
+        "frontend/react-hooks"
+      ]
+    },
     {
       "group": "API reference",
       "pages": [
         "management/overview",
         {
           "group": "Tasks API",
-          "pages": ["management/tasks/trigger", "management/tasks/batch-trigger"]
+          "pages": [
+            "management/tasks/trigger",
+            "management/tasks/batch-trigger"
+          ]
         },
         {
           "group": "Runs API",
@@ -212,7 +249,9 @@
         },
         {
           "group": "Projects API",
-          "pages": ["management/projects/runs"]
+          "pages": [
+            "management/projects/runs"
+          ]
         }
       ]
     },
@@ -258,11 +297,17 @@
     },
     {
       "group": "Help",
-      "pages": ["community", "help-slack", "help-email"]
+      "pages": [
+        "community",
+        "help-slack",
+        "help-email"
+      ]
     },
     {
       "group": "",
-      "pages": ["guides/introduction"]
+      "pages": [
+        "guides/introduction"
+      ]
     },
     {
       "group": "Frameworks",
@@ -321,16 +366,20 @@
     },
     {
       "group": "Dashboard",
-      "pages": ["guides/dashboard/creating-a-project"]
+      "pages": [
+        "guides/dashboard/creating-a-project"
+      ]
     },
     {
       "group": "Migrations",
-      "pages": ["guides/use-cases/upgrading-from-v2"]
+      "pages": [
+        "guides/use-cases/upgrading-from-v2"
+      ]
     }
   ],
   "footerSocials": {
     "twitter": "https://twitter.com/triggerdotdev",
     "github": "https://github.com/triggerdotdev",
     "linkedin": "https://www.linkedin.com/company/triggerdotdev"
   }
-}
+}