Skip to content

The open-source agent harness - the runtime layer that turns an LLM into a working agent.

docs: fold UI SDK tab into Documentation > UI Chat (#248)

Govinda Vashishthace9e802ff685
diff --git a/docs/chat-ui.mdx b/docs/chat-ui.mdx
index 6ba05cbb4..8a9e1b8e6 100644
--- a/docs/chat-ui.mdx
+++ b/docs/chat-ui.mdx
@@ -1,10 +1,19 @@
---
-title: 'Chat UI'
-sidebarTitle: 'Chat UI'
+title: 'TrueForge UI SDK'
+sidebarTitle: 'Overview'
description: 'Use the bundled TrueForge chat experience — or embed the same UI in your app with the React UI SDK.'
---
-TrueForge ships a full chat UI with the server: browse agents, stream responses, approve tools, connect MCP OAuth, and manage Settings. The same experience is published as `@truefoundry/trueforge-ui` so you can embed it in your own React app.
+`@truefoundry/trueforge-ui` provides a production-ready agent chat experience as a single, reusable React component. TrueForge ships this full chat UI with the server — browse agents, stream responses, approve tools, connect MCP OAuth, and manage Settings — and publishes the same experience as `@truefoundry/trueforge-ui` so you can embed it in your own React app.
+
+Key Features:
+
+- **Agent Modes** - Chat with a single agent, browse an agent library, or allow users to create and compose new agents.
+- **Chat** - Supports streaming responses, session history, tool calls with approval workflows, and file attachments.
+- **Themes** - Includes built-in themes for Claude, ChatGPT, Gemini, and TrueFoundry, with support for creating custom themes.
+- **Layouts** - Supports full-screen layouts with a sidebar or drawer, as well as embedded layouts with side-docked or floating widgets.
+- **Integration Settings** - Configure models, MCP servers, skills, and sandbox environments.
+- **Server Configuration** - Choose between TrueForge, a fully custom server, or TrueFoundry.
## Bundled UI
@@ -35,7 +44,7 @@ export function App() {
}
```
-Interactive playground and generated snippets: [ui.trueforge.dev](https://ui.trueforge.dev/).
+See the [Quickstart](/ui-sdk/get-started/quickstart) for a complete setup.
## What you can customize
@@ -47,4 +56,8 @@ Interactive playground and generated snippets: [ui.trueforge.dev](https://ui.tru
| **Slots** | Override individual UI regions without forking the whole app |
| **Server** | TrueForge server, TrueFoundry-backed, or a custom server that implements the contract |
-Deep dives, API reference, and advanced guides live in the **UI SDK** tab of these docs.
+## Interactive controls & code examples
+
+The hosted webapp provides an interactive interface for exploring and configuring all available controls and properties. Configure and preview component properties, override defaults, and generate a code snippet from your configuration.
+
+[https://ui.trueforge.dev/](https://ui.trueforge.dev/)
diff --git a/docs/docs.json b/docs/docs.json
index 08e484bbe..968a5043c 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -72,52 +72,38 @@
"pages": ["api/overview", "api/use-agent", "api/turn-events"]
},
{
- "group": "Chat UI",
- "pages": ["chat-ui"]
- },
- {
- "group": "Project",
- "pages": ["roadmap"]
- }
- ]
- },
- {
- "tab": "UI SDK",
- "groups": [
- {
- "group": "Get started",
- "pages": ["ui-sdk/index", "ui-sdk/get-started/quickstart"]
- },
- {
- "group": "Frontend Customisation",
+ "group": "UI Chat",
"pages": [
- "ui-sdk/guides/layouts",
- "ui-sdk/guides/layouts-and-theme",
- "ui-sdk/guides/agent-modes",
- "ui-sdk/setup-custom-ui/custom-theme",
- "ui-sdk/guides/troubleshooting"
- ]
- },
- {
- "group": "Server Customisations",
- "pages": [
- "ui-sdk/setup-custom-servers/connect-with-truefoundry",
- "ui-sdk/setup-custom-servers/custom-server",
- "ui-sdk/setup-custom-servers/server-contract"
+ "chat-ui",
+ "ui-sdk/get-started/quickstart",
+ {
+ "group": "Frontend Customisation",
+ "pages": [
+ "ui-sdk/guides/layouts",
+ "ui-sdk/guides/layouts-and-theme",
+ "ui-sdk/guides/agent-modes",
+ "ui-sdk/setup-custom-ui/custom-theme",
+ "ui-sdk/guides/troubleshooting"
+ ]
+ },
+ {
+ "group": "API reference",
+ "pages": [
+ "ui-sdk/reference/trueforge-ui",
+ "ui-sdk/reference/theme",
+ "ui-sdk/reference/containers",
+ "ui-sdk/reference/atoms",
+ "ui-sdk/reference/hooks",
+ "ui-sdk/reference/server",
+ "ui-sdk/reference/events",
+ "ui-sdk/reference/catalog"
+ ]
+ }
]
},
{
- "group": "API reference",
- "pages": [
- "ui-sdk/reference/trueforge-ui",
- "ui-sdk/reference/theme",
- "ui-sdk/reference/containers",
- "ui-sdk/reference/atoms",
- "ui-sdk/reference/hooks",
- "ui-sdk/reference/server",
- "ui-sdk/reference/events",
- "ui-sdk/reference/catalog"
- ]
+ "group": "Project",
+ "pages": ["roadmap"]
}
]
},
diff --git a/docs/introduction.mdx b/docs/introduction.mdx
index d60e9e628..a67f28758 100644
--- a/docs/introduction.mdx
+++ b/docs/introduction.mdx
@@ -136,7 +136,7 @@ Like Claude's managed agents: one deployment the whole company uses, via Docker
<Card title="Benchmarking" icon="chart-line" href="/benchmarking">
Same tasks and model vs Claude Managed Agents and deepagents — cost and accuracy.
</Card>
- <Card title="UI SDK reference" icon="book" href="/ui-sdk/index">
+ <Card title="UI SDK reference" icon="book" href="/chat-ui">
Themes, layouts, slots, and the full React component API.
</Card>
</CardGroup>
diff --git a/docs/ui-sdk/index.mdx b/docs/ui-sdk/index.mdx
deleted file mode 100644
index e465c5db6..000000000
--- a/docs/ui-sdk/index.mdx
+++ /dev/null
@@ -1,31 +0,0 @@
----
-title: "TrueForge UI SDK"
-description: "A themeable React SDK for building AI agent chat applications."
----
-
-`@truefoundry/trueforge-ui` provides a production-ready agent chat experience as a single, reusable React component that can be integrated into an existing application.
-
-Key Features:
-
-- **Agent Modes** - Chat with a single agent, browse an agent library, or allow users to create and compose new agents.
-- **Chat** - Supports streaming responses, session history, tool calls with approval workflows, and file attachments.
-- **Themes** - Includes built-in themes for Claude, ChatGPT, Gemini, and TrueFoundry, with support for creating custom themes.
-- **Layouts** - Supports full-screen layouts with a sidebar or drawer, as well as embedded layouts with side-docked or floating widgets.
-- **Integration Settings** - Configure models, MCP servers, skills, and sandbox environments.
-- **Server Configuration** - Choose between TrueForge, a fully custom server, or TrueFoundry.
-
-<br />
-
-## Interactive Controls & Code Examples
-
-The hosted webapp provides an interactive interface for exploring and configuring all available controls and properties.
-
-You can:
-
-- Configure and preview component properties
-- Override default settings
-- Generate a code snippet based on your configuration
-
-This provides a simple way to experiment with configurations and quickly integrate the resulting setup into your application.
-
-[https://ui.trueforge.dev/](https://ui.trueforge.dev/)
\ No newline at end of file