Skip to content

Commit 3d80e49

Browse files
authored
docs: improve getting started and add devtools section (TanStack#69)
1 parent e29cc5d commit 3d80e49

2 files changed

Lines changed: 51 additions & 0 deletions

File tree

docs/getting-started/devtools.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Devtools
3+
id: devtools
4+
---
5+
6+
TanStack Devtools is a unified devtools panel for inspecting and debugging TanStack libraries, including TanStack AI. It provides real-time insights into AI interactions, tool calls, and state changes, making it easier to develop and troubleshoot AI-powered applications.
7+
8+
## Features
9+
- **Real-time Monitoring** - View live chat messages, tool invocations, and AI responses.
10+
- **Tool Call Inspection** - Inspect input and output of tool calls.
11+
- **State Visualization** - Visualize chat state and message history.
12+
- **Error Tracking** - Monitor errors and exceptions in AI interactions.
13+
14+
## Installation
15+
To use TanStack Devtools with TanStack AI, install the `@tanstack/ai-react-devtools` package:
16+
17+
```bash
18+
npm install @tanstack/ai-react-devtools
19+
```
20+
21+
Or the `@tanstack/ai-solid-devtools` package for SolidJS:
22+
```bash
23+
npm install @tanstack/ai-solid-devtools
24+
```
25+
26+
## Usage
27+
28+
Import and include the Devtools component in your application:
29+
30+
```tsx
31+
import { aiDevtoolsPlugin } from '@tanstack/ai-react-devtools'
32+
33+
const App = () => {
34+
return (
35+
<>
36+
<TanStackDevtools
37+
plugins={[
38+
// ... other plugins
39+
aiDevtoolsPlugin(),
40+
]}
41+
// this config is important to connect to the server event bus
42+
eventBusConfig={{
43+
connectToServerBus: true,
44+
}}
45+
/>
46+
</>
47+
)
48+
}
49+
```

docs/getting-started/overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ The core AI library that provides:
5656
- Isomorphic tool/function calling system
5757
- Agent loop strategies
5858
- Type-safe tool definitions with `toolDefinition()`
59+
- Type-safe provider options based on adapter & model selection
60+
- Type-safe content modalities (text, image, audio, video, document) based on model capabilities
5961

6062
### `@tanstack/ai-client`
6163
A framework-agnostic headless client for managing chat state:

0 commit comments

Comments
 (0)