Skip to content

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

docs(ui-sdk): add screenshots and interactive demos (#118)

shubhamagarwal-createcc88fc1352f4
diff --git a/docs/images/agent-registry.png b/docs/images/agent-registry.png
new file mode 100644
index 000000000..3bc7c7b4b
Binary files /dev/null and b/docs/images/agent-registry.png differ
diff --git a/docs/images/custom.png b/docs/images/custom.png
new file mode 100644
index 000000000..6f608d594
Binary files /dev/null and b/docs/images/custom.png differ
diff --git a/docs/images/dark_theme.png b/docs/images/dark_theme.png
new file mode 100644
index 000000000..1e1d1708f
Binary files /dev/null and b/docs/images/dark_theme.png differ
diff --git a/docs/images/dock.png b/docs/images/dock.png
new file mode 100644
index 000000000..50e9e7926
Binary files /dev/null and b/docs/images/dock.png differ
diff --git a/docs/images/drawer.png b/docs/images/drawer.png
new file mode 100644
index 000000000..6b82dcf19
Binary files /dev/null and b/docs/images/drawer.png differ
diff --git a/docs/images/hero.png b/docs/images/hero.png
new file mode 100644
index 000000000..365dc508c
Binary files /dev/null and b/docs/images/hero.png differ
diff --git a/docs/images/sidebar.png b/docs/images/sidebar.png
new file mode 100644
index 000000000..1d3d55dac
Binary files /dev/null and b/docs/images/sidebar.png differ
diff --git a/docs/images/theme-chatgpt.png b/docs/images/theme-chatgpt.png
new file mode 100644
index 000000000..5eae2f0d1
Binary files /dev/null and b/docs/images/theme-chatgpt.png differ
diff --git a/docs/images/theme-claude.png b/docs/images/theme-claude.png
new file mode 100644
index 000000000..7bb47aaed
Binary files /dev/null and b/docs/images/theme-claude.png differ
diff --git a/docs/images/theme-gemini.png b/docs/images/theme-gemini.png
new file mode 100644
index 000000000..d3a8e62f3
Binary files /dev/null and b/docs/images/theme-gemini.png differ
diff --git a/docs/images/widget.png b/docs/images/widget.png
new file mode 100644
index 000000000..6338bf3c4
Binary files /dev/null and b/docs/images/widget.png differ
diff --git a/docs/ui-sdk/concepts/agent-modes.mdx b/docs/ui-sdk/concepts/agent-modes.mdx
index 24e100f00..9d02cc3aa 100644
--- a/docs/ui-sdk/concepts/agent-modes.mdx
+++ b/docs/ui-sdk/concepts/agent-modes.mdx
@@ -30,10 +30,25 @@ The default is `{ mode: "AgentLibraryWithComposer" }`.
<Accordion title="AgentLibrary">
Users pick from agents your `searchAgents` implementation returns, but cannot author a
new one. Note that "new chat" is disabled in this mode only.
+
+ <Frame caption="The Agents Library: users pick from the agents your `searchAgents` returns.">
+ <img src="/images/agent-registry.png" alt="The Agents Library dialog listing saved agents to choose from" />
+ </Frame>
</Accordion>
<Accordion title="AgentComposer">
Users assemble an ad-hoc agent — model, skills, MCP servers — without browsing a
- library.
+ library, and can save it back to the library.
+
+ <div style={{ position: "relative", boxSizing: "content-box", width: "100%", aspectRatio: "1.46", padding: "40px 0" }}>
+ <iframe
+ src="https://app.supademo.com/embed/cmsk13xio00k81p0j1wj6amj6?embed_v=2&utm_source=embed"
+ loading="lazy"
+ title="Compose an agent in TrueForge"
+ allow="clipboard-write"
+ allowFullScreen
+ style={{ position: "absolute", top: 0, left: 0, width: "100%", height: "100%", border: 0 }}
+ />
+ </div>
</Accordion>
<Accordion title="AgentLibraryWithComposer">
Both surfaces, and the default. Users can pick an existing agent or author a new one.
diff --git a/docs/ui-sdk/guides/layouts.mdx b/docs/ui-sdk/guides/layouts.mdx
index 6f9d61aee..17fcbfe27 100644
--- a/docs/ui-sdk/guides/layouts.mdx
+++ b/docs/ui-sdk/guides/layouts.mdx
@@ -13,6 +13,10 @@ description: "The four built-in layouts, and how to supply your own."
```tsx
<TrueforgeUI server={server} layout="sidebar" />
```
+
+ <Frame caption="Sidebar: full-page chat with the thread list pinned on the left.">
+ <img src="/images/sidebar.png" alt="Sidebar layout — a persistent thread list on the left beside a full-page chat" />
+ </Frame>
</Tab>
<Tab title="drawer">
Thread list collapses into an overlay drawer. Suited to narrower viewports.
@@ -20,6 +24,10 @@ description: "The four built-in layouts, and how to supply your own."
```tsx
<TrueforgeUI server={server} layout="drawer" />
```
+
+ <Frame caption="Drawer: the thread list collapses into an overlay for narrow viewports.">
+ <img src="/images/drawer.png" alt="Drawer layout — the thread list collapsed into an overlay drawer" />
+ </Frame>
</Tab>
<Tab title="dock">
A panel pinned to the right edge, filling the available width up to a 400px cap. The side is
@@ -28,6 +36,10 @@ description: "The four built-in layouts, and how to supply your own."
```tsx
<TrueforgeUI server={server} layout="dock" />
```
+
+ <Frame caption="Dock: a compact panel pinned to the right edge, up to a 400px cap.">
+ <img src="/images/dock.png" alt="Dock layout — a compact chat panel pinned to the right edge of the app" />
+ </Frame>
</Tab>
<Tab title="widget">
Floating launcher that expands into a compact chat panel.
@@ -35,6 +47,10 @@ description: "The four built-in layouts, and how to supply your own."
```tsx
<TrueforgeUI server={server} layout="widget" />
```
+
+ <Frame caption="Widget: a floating launcher that expands into a compact chat panel.">
+ <img src="/images/widget.png" alt="Widget layout — a floating launcher expanded into a compact chat panel" />
+ </Frame>
</Tab>
</Tabs>
@@ -69,6 +85,10 @@ function MyLayout() {
<TrueforgeUI server={server} layout={MyLayout} />;
```
+<Frame caption="A custom layout renders inside the full provider stack, so every container hook still works.">
+ <img src="/images/custom.png" alt="A custom TrueForge layout composed from a thread list and a chat pane" />
+</Frame>
+
`Thread` is a convenience wrapper equal to
`<ThreadContainer composer={<ComposerContainer />} />`. Split them apart when you need the
composer somewhere other than directly beneath the transcript.
diff --git a/docs/ui-sdk/guides/mcp-oauth.mdx b/docs/ui-sdk/guides/mcp-oauth.mdx
index 8dace8e00..07e919fe9 100644
--- a/docs/ui-sdk/guides/mcp-oauth.mdx
+++ b/docs/ui-sdk/guides/mcp-oauth.mdx
@@ -35,6 +35,17 @@ Authorizing a connector from the settings panel is the flow with the popup and t
route. It runs through `catalog.connectorCatalog.authenticateConnector` and requires a
[catalog server](/ui-sdk/reference/catalog).
+<div style={{ position: "relative", boxSizing: "content-box", width: "100%", aspectRatio: "1.76", padding: "40px 0" }}>
+ <iframe
+ src="https://app.supademo.com/embed/cmsk41dja008uzq0j2pgk0y7r?embed_v=2&utm_source=embed"
+ loading="lazy"
+ title="Connect an MCP server from the settings panel"
+ allow="clipboard-write"
+ allowFullScreen
+ style={{ position: "absolute", top: 0, left: 0, width: "100%", height: "100%", border: 0 }}
+ />
+</div>
+
```ts
import { useMCPAuth, MCP_AUTH_POPUP_CHANNEL } from "@truefoundry/trueforge-ui";
diff --git a/docs/ui-sdk/guides/theming.mdx b/docs/ui-sdk/guides/theming.mdx
index f9b7bed79..c47ffde82 100644
--- a/docs/ui-sdk/guides/theming.mdx
+++ b/docs/ui-sdk/guides/theming.mdx
@@ -33,6 +33,20 @@ type ThemeConfig = {
/>
```
+The `chatgpt`, `claude`, and `gemini` presets (the default is `truefoundry`):
+
+<Columns cols={3}>
+ <Frame caption="chatgpt">
+ <img src="/images/theme-chatgpt.png" alt="TrueForge UI with the chatgpt theme preset" />
+ </Frame>
+ <Frame caption="claude">
+ <img src="/images/theme-claude.png" alt="TrueForge UI with the claude theme preset" />
+ </Frame>
+ <Frame caption="gemini">
+ <img src="/images/theme-gemini.png" alt="TrueForge UI with the gemini theme preset" />
+ </Frame>
+</Columns>
+
## Precedence
The provider resolves the preset for the current mode, merges your `theme.tokens` over it, and
@@ -70,6 +84,10 @@ no-op and you own the state.
`theme.mode` derived from your own state to keep them in sync.
</Warning>
+<Frame caption="Dark mode applied to the chat UI.">
+ <img src="/images/dark_theme.png" alt="The TrueForge UI SDK rendered in dark mode" />
+</Frame>
+
## Reading theme state
```tsx
diff --git a/docs/ui-sdk/index.mdx b/docs/ui-sdk/index.mdx
index e55c3706b..b304df235 100644
--- a/docs/ui-sdk/index.mdx
+++ b/docs/ui-sdk/index.mdx
@@ -10,6 +10,13 @@ existing app. It is built on [assistant-ui](https://www.assistant-ui.com/) and f
shadcn/ui conventions, so branding, layout, and individual components stay under your
control.
+<Frame caption="A TrueForge UI chat session — streaming response, agent steps, and tool calls.">
+ <img
+ src="/images/hero.png"
+ alt="The TrueForge UI SDK rendering an agent chat with an expandable agent-steps panel and a streamed response"
+ />
+</Frame>
+
<CardGroup cols={2}>
<Card title="Installation" icon="download" href="/ui-sdk/get-started/installation">
Install the package, wire up the stylesheet, and satisfy the peer dependencies.