Skip to content

Commit 6853b45

Browse files
committed
Refactor quickstart documentation and remove deprecated pages
- Updated the quickstart section to replace "build" and "connect" pages with "middleware" and "server" pages. - Removed the "build" and "connect" documentation files as they are no longer relevant. - Adjusted the introduction to reflect the new quickstart paths and updated card titles accordingly. - Updated routing in the docs configuration to align with the new structure.
1 parent 2b287ba commit 6853b45

File tree

16 files changed

+48
-43
lines changed

16 files changed

+48
-43
lines changed

docs/docs.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"introduction",
2020
{
2121
"group": "Quickstart",
22-
"pages": ["quickstart/build", "quickstart/connect"]
22+
"pages": ["quickstart/middleware", "quickstart/server"]
2323
},
2424
"integrations"
2525
]
@@ -126,6 +126,14 @@
126126
{
127127
"source": "/quickstart",
128128
"destination": "/quickstart/build"
129+
},
130+
{
131+
"source": "/quickstart/connect",
132+
"destination": "/quickstart/middleware"
133+
},
134+
{
135+
"source": "/quickstart/build",
136+
"destination": "/quickstart/server"
129137
}
130138
]
131139
}

docs/introduction.mdx

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -136,24 +136,27 @@ These protocols serve complementary purposes in the agent ecosystem:
136136
Choose the path that fits your needs:
137137

138138
<CardGroup cols={2}>
139-
<Card
140-
title="Build with AG-UI"
141-
icon="wrench"
142-
href="/quickstart/build"
139+
<Card
140+
title="AG-UI Middleware Connectors"
141+
icon="bolt"
142+
href="/quickstart/middleware"
143143
color="#3B82F6"
144144
iconType="solid"
145145
>
146-
Implement AG-UI events directly in your agent framework
146+
Connect AG-UI with existing protocols, in process agents or custom solutions
147+
**using TypeScript**
147148
</Card>
149+
148150
<Card
149-
title="Connect to AG-UI"
150-
icon="bolt"
151-
href="/quickstart/connect"
151+
title="AG-UI Compatible Servers"
152+
icon="wrench"
153+
href="/quickstart/server"
152154
color="#3B82F6"
153155
iconType="solid"
154156
>
155-
Connect AG-UI with existing protocols or custom solutions
157+
Implement AG-UI compatible servers **using Python or TypeScript**
156158
</Card>
159+
157160
</CardGroup>
158161

159162
## Resources
@@ -207,18 +210,7 @@ Dive deeper into AG-UI's core concepts and capabilities:
207210
>
208211
Understand how AG-UI connects agents, protocols, and front-ends
209212
</Card>
210-
{/* <Card title="Resources" icon="database" href="/docs/concepts/resources">
211-
Expose data and content from your servers to LLMs
212-
</Card>
213-
<Card title="Prompts" icon="message" href="/docs/concepts/prompts">
214-
Create reusable prompt templates and workflows
215-
</Card>
216-
<Card title="Tools" icon="wrench" href="/docs/concepts/tools">
217-
Enable LLMs to perform actions through your server
218-
</Card>
219-
<Card title="Sampling" icon="robot" href="/docs/concepts/sampling">
220-
Let your servers request completions from LLMs
221-
</Card> */}
213+
222214
<Card
223215
title="Transports"
224216
icon="network-wired"

docs/quickstart/connect.mdx renamed to docs/quickstart/middleware.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2-
title: "Connect to AG-UI"
3-
description: "Connect AG-UI with existing protocols or custom solutions"
2+
title: "AG-UI Middleware Connectors"
3+
description:
4+
"Connect AG-UI with existing protocols, in process agents or custom solutions
5+
using TypeScript"
46
---
57

68
# Getting Started with AG-UI
@@ -53,10 +55,10 @@ git clone [email protected]:ag-ui-protocol/ag-ui.git
5355
cd ag-ui/typescript-sdk
5456
```
5557

56-
Copy the starter template to create your OpenAI integration:
58+
Copy the middleware-starter template to create your OpenAI integration:
5759

5860
```bash
59-
cp -r integrations/starter integrations/openai
61+
cp -r integrations/middleware-starter integrations/openai
6062
```
6163

6264
### Update metadata
@@ -133,7 +135,7 @@ Head over to [http://localhost:3000](http://localhost:3000) and choose
133135
**OpenAI** from the drop-down. You'll see the stub agent replies with **Hello
134136
world!** for now.
135137

136-
Here's what's happening with that stub agent (`StarterAgent`):
138+
Here's what's happening with that stub agent:
137139

138140
```ts
139141
// integrations/openai/src/index.ts

docs/quickstart/build.mdx renamed to docs/quickstart/server.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Build with AG-UI"
3-
description: "Implement AG-UI events directly in your agent framework"
2+
title: "AG-UI Compatible Servers"
3+
description: "Implement AG-UI compatible servers"
44
---
55

66
In this tutorial, you'll learn how to build an HTTP endpoint that is compatible

typescript-sdk/apps/dojo/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
},
1111
"dependencies": {
1212
"@ag-ui/mastra": "workspace:*",
13-
"@ag-ui/starter": "workspace:*",
13+
"@ag-ui/middleware-starter": "workspace:*",
1414
"@ag-ui/vercel-ai-sdk": "workspace:*",
1515
"@ai-sdk/openai": "^1.3.22",
1616
"@copilotkit/react-core": "1.8.12",

typescript-sdk/apps/dojo/src/agents.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
import { AgentIntegrationConfig } from "./types/integration";
2-
import { StarterAgent } from "@ag-ui/starter";
2+
import { MiddlewareStarterAgent } from "@ag-ui/middleware-starter";
33
import { MastraClient } from "@mastra/client-js";
44
import { MastraAgent } from "@ag-ui/mastra";
55
import { VercelAISDKAgent } from "@ag-ui/vercel-ai-sdk";
66
import { openai } from "@ai-sdk/openai";
77

88
export const agentsIntegrations: AgentIntegrationConfig[] = [
99
{
10-
id: "starter",
10+
id: "middleware-starter",
1111
agents: async () => {
1212
return {
13-
agentic_chat: new StarterAgent(),
13+
agentic_chat: new MiddlewareStarterAgent(),
1414
};
1515
},
1616
},

typescript-sdk/apps/dojo/src/app/[integrationId]/not-found.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ export default function NotFound() {
66
<div className="flex-1 h-screen w-full flex flex-col items-center justify-center p-8">
77
<h1 className="text-4xl font-bold text-center mb-4">Integration Not Found</h1>
88
<p className="text-muted-foreground mb-6 text-center">
9-
The integration you're looking for doesn't exist.
9+
The integration you&apos;re looking for doesn&apos;t exist.
1010
</p>
1111
<Link
1212
href="/"

typescript-sdk/apps/dojo/src/components/sidebar/sidebar.tsx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ import {
1717
} from "../ui/dropdown-menu";
1818
import { Button } from "../ui/button";
1919
import { menuIntegrations } from "@/menu";
20+
import { Feature } from "@/types/integration";
2021

2122
interface SidebarProps {
2223
activeTab?: string;
@@ -42,7 +43,9 @@ export function Sidebar({ activeTab = "preview", onTabChange, readmeContent }: S
4243

4344
// Filter demos based on current integration's features
4445
const filteredDemos = currentIntegration
45-
? featureConfig.filter((demo) => currentIntegration.features.includes(demo.id))
46+
? featureConfig.filter((demo) =>
47+
currentIntegration.features.includes(demo as unknown as Feature),
48+
)
4649
: []; // Show no demos if no integration is selected
4750

4851
// Handle selecting a demo

typescript-sdk/apps/dojo/src/menu.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ import { MenuIntegrationConfig } from "./types/integration";
22

33
export const menuIntegrations: MenuIntegrationConfig[] = [
44
{
5-
id: "starter",
6-
name: "Starter",
5+
id: "middleware-starter",
6+
name: "Middleware Starter",
77
features: ["agentic_chat"],
88
},
99
{
File renamed without changes.

0 commit comments

Comments
 (0)