docs: reorder pages (#1150)

assistant-ui · Nov 11, 2024 · 132e5ba · 132e5ba
1 parent dd8b131
commit 132e5ba
Show file tree

Hide file tree

Showing 10 changed files with 16 additions and 14 deletions.
diff --git a/apps/docs/content/docs/architecture.mdx → ...cs/content/docs/concepts/architecture.mdx b/apps/docs/content/docs/architecture.mdx → ...cs/content/docs/concepts/architecture.mdx
@@ -3,7 +3,7 @@ title: Architecture
 ---
 
 import Image from "next/image";
-import architecture from "../../assets/docs/architecture.png";
+import architecture from "@/assets/docs/architecture.png";
 
 ### Architecture
 

diff --git a/apps/docs/content/docs/concepts/meta.json b/apps/docs/content/docs/concepts/meta.json
@@ -1,4 +1,4 @@
 {
   "title": "Concepts",
-  "pages": ["runtime-layer"]
+  "pages": ["architecture", "runtime-layer"]
 }
diff --git a/...ocs/content/docs/advanced/Attachments.mdx → .../docs/content/docs/guides/Attachments.mdx b/...ocs/content/docs/advanced/Attachments.mdx → .../docs/content/docs/guides/Attachments.mdx
diff --git a/.../docs/content/docs/advanced/Branching.mdx → apps/docs/content/docs/guides/Branching.mdx b/.../docs/content/docs/advanced/Branching.mdx → apps/docs/content/docs/guides/Branching.mdx
diff --git a/apps/docs/content/docs/advanced/Editing.mdx → apps/docs/content/docs/guides/Editing.mdx b/apps/docs/content/docs/advanced/Editing.mdx → apps/docs/content/docs/guides/Editing.mdx
diff --git a/apps/docs/content/docs/advanced/Speech.mdx → apps/docs/content/docs/guides/Speech.mdx b/apps/docs/content/docs/advanced/Speech.mdx → apps/docs/content/docs/guides/Speech.mdx
diff --git a/apps/docs/content/docs/advanced/ToolUI.mdx → apps/docs/content/docs/guides/ToolUI.mdx b/apps/docs/content/docs/advanced/ToolUI.mdx → apps/docs/content/docs/guides/ToolUI.mdx
diff --git a/apps/docs/content/docs/guides/meta.json b/apps/docs/content/docs/guides/meta.json
@@ -0,0 +1,4 @@
+{
+  "title": "Guides",
+  "pages": ["Attachments", "Branching", "Editing", "Speech", "ToolUI"]
+}
diff --git a/apps/docs/content/docs/meta.json b/apps/docs/content/docs/meta.json
@@ -3,15 +3,13 @@
   "root": true,
   "pages": [
     "getting-started",
-    "architecture",
+    "guides",
+    "concepts",
+    "migrations",
+    "reference",
     "---UI---",
     "...ui",
     "---Runtimes---",
-    "...runtimes",
-    "---Advanced---",
-    "...advanced",
-    "concepts",
-    "migrations",
-    "reference"
+    "...runtimes"
   ]
 }
diff --git a/apps/docs/content/docs/reference/context.mdx b/apps/docs/content/docs/reference/context.mdx
@@ -13,7 +13,6 @@ The context is split into four hierarchies:
 
 import { ParametersTable } from "@/components/docs";
 import {
-  AssistantRuntimeState,
   AssistantToolUIsState,
   ThreadState,
   ThreadMessagesState,
@@ -27,26 +26,27 @@ import {
   ComposerAttachmentState,
   MessageAttachmentState,
 } from "@/components/docs/parameters/context";
+import { AssistantRuntime, ThreadRuntime } from "@/generated/typeDocs";
 
 ## Assistant Context
 
-#### `useAssistantRuntime`
+### `useAssistantRuntime`
 
 ```tsx
 import { useAssistantRuntime } from "@assistant-ui/react";
 
 const runtime = useAssistantRuntime();
 ```
 
-<ParametersTable {...AssistantRuntimeState} />
+<ParametersTable {...AssistantRuntime} />
 
 ### `useToolUIs`
 
 ```tsx
 import { useToolUIs } from "@assistant-ui/react";
 
 const toolUIs = useToolUIs();
-const getToolUI = useToolUIs((m) => m.getToolUI);
+const webSearchToolUI = useToolUIs((m) => m.getToolUI("web_search"));
 ```
 
 <ParametersTable {...AssistantToolUIsState} />
@@ -61,7 +61,7 @@ import { useThreadRuntime } from "@assistant-ui/react";
 const thread = useThreadRuntime();
 ```
 
-<ParametersTable {...ThreadRuntimeState} />
+<ParametersTable {...ThreadRuntime} />
 
 ### `useThread`