Skip to content

Commit 5ed08c6

Browse files
committed
update docs
1 parent 966bf5f commit 5ed08c6

File tree

17 files changed

+53
-60
lines changed

17 files changed

+53
-60
lines changed

CLAUDE.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
66

77
### TypeScript SDK (Main Development)
88
```bash
9-
# Navigate to typescript-sdk directory for all TypeScript work
10-
cd typescript-sdk
119

1210
# Install dependencies (using pnpm)
1311
pnpm install
@@ -55,11 +53,11 @@ poetry build
5553
### Running Specific Integration Tests
5654
```bash
5755
# For TypeScript packages/integrations
58-
cd typescript-sdk/packages/<package-name>
56+
cd packages/<package-name>
5957
pnpm test
6058

6159
# For running a single test file
62-
cd typescript-sdk/packages/<package-name>
60+
cd packages/<package-name>
6361
pnpm test -- path/to/test.spec.ts
6462
```
6563

@@ -78,11 +76,11 @@ AG-UI is an event-based protocol that standardizes agent-user interactions. The
7876
3. **Event Types**: Lifecycle events (RUN_STARTED/FINISHED), message events (TEXT_MESSAGE_*), tool events (TOOL_CALL_*), and state management events (STATE_SNAPSHOT/DELTA)
7977

8078
### Repository Structure
81-
- `/typescript-sdk/`: Main TypeScript implementation
79+
- `/sdks/typescript/`: Main TypeScript implementation
8280
- `/packages/`: Core protocol packages (@ag-ui/core, @ag-ui/client, @ag-ui/encoder, @ag-ui/proto)
83-
- `/integrations/`: Framework integrations (langgraph, mastra, crewai, etc.)
84-
- `/apps/`: Example applications including the AG-UI Dojo demo viewer
85-
- `/python-sdk/`: Python implementation of the protocol
81+
- `/integrations/`: Framework integrations (langgraph, mastra, crewai, etc.)
82+
- `/apps/`: Example applications including the AG-UI Dojo demo viewer
83+
- `/sdks/python/`: Python implementation of the protocol
8684
- `/docs/`: Documentation site content
8785

8886
### Integration Pattern
@@ -108,4 +106,4 @@ Each framework integration follows a similar pattern:
108106
- Turbo is used for monorepo build orchestration
109107
- Each package has independent versioning
110108
- Integration tests demonstrate protocol compliance
111-
- The AG-UI Dojo app showcases all protocol features with live examples
109+
- The AG-UI Dojo app showcases all protocol features with live examples

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ AG-UI is complementary to the other 2 top agentic protocols
6363

6464
<div align="center">
6565
<img width="2048" height="1182" alt="The Agent Protocol Stack" src="https://github.com/user-attachments/assets/41138f71-50be-4812-98aa-20e0ad595716" />
66-
</div>
67-
66+
</div>
67+
6868
## 🚀 Features
6969

7070
- 💬 Real-time agentic chat with streaming
@@ -138,9 +138,9 @@ https://agui-demo.vercel.app/
138138

139139

140140
## The AG-UI Dojo (Building-Blocks Viewer)
141-
The AG-UI Dojo demonstrates AG-UI's core building blocks through simple, focused examples—each just 50-200 lines of code.
141+
The AG-UI Dojo demonstrates AG-UI's core building blocks through simple, focused examples—each just 50-200 lines of code.
142142

143-
View the source code for the Dojo and all framework integrations [here](https://github.com/ag-ui-protocol/ag-ui/tree/main/typescript-sdk/apps/dojo).
143+
View the source code for the Dojo and all framework integrations [here](https://github.com/ag-ui-protocol/ag-ui/tree/main/apps/dojo).
144144

145145
https://github.com/user-attachments/assets/c298eea8-3f39-4a94-b968-7712429b0c49
146146

@@ -150,7 +150,7 @@ https://github.com/user-attachments/assets/c298eea8-3f39-4a94-b968-7712429b0c49
150150

151151
Check out the [Contributing guide](https://github.com/ag-ui-protocol/ag-ui/blob/main/CONTRIBUTING.md)
152152

153-
- **[Bi-Weekely AG-UI Working Group](https://lu.ma/CopilotKit?k=c)**
153+
- **[Bi-Weekely AG-UI Working Group](https://lu.ma/CopilotKit?k=c)**
154154
📅 Follow the CopilotKit Luma Events Calendar
155155

156156
## Roadmap
@@ -160,4 +160,4 @@ Check out the [AG-UI Roadmap](https://github.com/orgs/ag-ui-protocol/projects/1)
160160

161161
## 📄 License
162162

163-
AG-UI is open source software [licensed as MIT](https://opensource.org/licenses/MIT).
163+
AG-UI is open source software [licensed as MIT](https://opensource.org/licenses/MIT).

docs/development/contributing.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ description: How to participate in Agent User Interaction Protocol development
55

66
# Naming conventions
77

8-
Add your package under `typescript-sdk/integrations/` with docs and tests.
8+
Add your package under `integrations/` with docs and tests.
99

1010
If your integration is work in progress, you can still add it to main branch.
1111
You can prefix it with `wip-`, i.e.
12-
(`typescript-sdk/integrations/wip-your-integration`) or if you're a third party
12+
(`integrations/wip-your-integration`) or if you're a third party
1313
contributor use the `community` prefix, i.e.
14-
(`typescript-sdk/integrations/community-your-integration`).
14+
(`integrations/community/your-integration`).
1515

1616
For questions and discussions, please use
1717
[GitHub Discussions](https://github.com/ag-ui-protocol/ag-ui/discussions).

docs/quickstart/middleware.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,11 @@ curl -fsSL https://get.pnpm.io/install.sh | sh -
7272

7373
## Step 1 – Scaffold your integration
7474

75-
Start by cloning the repo and navigating to the TypeScript SDK:
75+
Start by cloning the repo
7676

7777
```bash
7878
git clone [email protected]:ag-ui-protocol/ag-ui.git
79-
cd ag-ui/typescript-sdk
79+
cd ag-ui/
8080
```
8181

8282
Copy the middleware-starter template to create your OpenAI integration:
@@ -417,7 +417,7 @@ Did you build a custom adapter that others could reuse? We welcome community
417417
contributions!
418418

419419
1. Fork the [AG-UI repository](https://github.com/ag-ui-protocol/ag-ui)
420-
2. Add your package under `typescript-sdk/integrations/`. See
420+
2. Add your package under `integrations`. See
421421
[Contributing](../development/contributing) for more details and naming
422422
conventions.
423423
3. Open a pull request describing your use-case and design decisions

docs/quickstart/server.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@ curl -fsSL https://get.pnpm.io/install.sh | sh -
6868

6969
## Step 1 – Scaffold your server
7070

71-
Start by cloning the repo and navigating to the TypeScript SDK:
71+
Start by cloning the repo:
7272

7373
```bash
7474
git clone [email protected]:ag-ui-protocol/ag-ui.git
75-
cd ag-ui/typescript-sdk
75+
cd ag-ui
7676
```
7777

7878
Copy the server-starter template to create your OpenAI server:
@@ -181,8 +181,6 @@ poetry install && poetry run dev
181181
In another terminal, start the dojo:
182182

183183
```bash
184-
cd typescript-sdk
185-
186184
# Install dependencies
187185
pnpm install
188186

@@ -442,7 +440,7 @@ Did you build a custom server that others could reuse? We welcome community
442440
contributions!
443441

444442
1. Fork the [AG-UI repository](https://github.com/ag-ui-protocol/ag-ui)
445-
2. Add your package under `typescript-sdk/integrations/`. See
443+
2. Add your package under `integrations/`. See
446444
[Contributing](../development/contributing) for more details and naming
447445
conventions.
448446
3. Open a pull request describing your use-case and design decisions

integrations/adk-middleware/python/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ To use this integration you need to:
1818
git clone https://github.com/ag-ui-protocol/ag-ui.git
1919
```
2020

21-
2. Change to the `typescript-sdk/integrations/adk-middleware` directory.
21+
2. Change to the `integrations/adk-middleware/python` directory.
2222

2323
```bash
24-
cd typescript-sdk/integrations/adk-middleware
24+
cd integrations/adk-middleware/python
2525
```
2626

2727
3. Install the `adk-middleware` package from the local directory. For example,
@@ -61,7 +61,6 @@ To use this integration you need to:
6161
7. Start the integration ag-ui dojo:
6262

6363
```bash
64-
cd typescript-sdk
6564
pnpm install && pnpm run dev
6665
```
6766

integrations/adk-middleware/typescript/README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ To use this integration you need to:
1818
git clone https://github.com/ag-ui-protocol/ag-ui.git
1919
```
2020

21-
2. Change to the `typescript-sdk/integrations/adk-middleware` directory.
21+
2. Change to the `integrations/adk-middleware/python` directory.
2222

2323
```bash
24-
cd typescript-sdk/integrations/adk-middleware
24+
cd integrations/adk-middleware/python
2525
```
2626

2727
3. Install the `adk-middleware` package from the local directory. For example,
@@ -30,12 +30,12 @@ To use this integration you need to:
3030
pip install .
3131
```
3232

33-
or
33+
or
3434

3535
```bash
3636
uv pip install .
3737
```
38-
38+
3939
This installs the package from the current directory which contains:
4040
- `src/adk_middleware/` - The middleware source code
4141
- `examples/` - Example servers and agents
@@ -61,7 +61,6 @@ To use this integration you need to:
6161
7. Start the integration ag-ui dojo:
6262

6363
```bash
64-
cd typescript-sdk
6564
pnpm install && pnpm run dev
6665
```
6766

@@ -125,7 +124,7 @@ my_agent = Agent(
125124
# 2. Create the middleware with direct agent embedding
126125
agent = ADKAgent(
127126
adk_agent=my_agent,
128-
app_name="my_app",
127+
app_name="my_app",
129128
user_id="user123"
130129
)
131130
@@ -150,7 +149,7 @@ my_agent = Agent(
150149
# 2. Create the middleware with direct agent embedding
151150
agent = ADKAgent(
152151
adk_agent=my_agent,
153-
app_name="my_app",
152+
app_name="my_app",
154153
user_id="user123"
155154
)
156155
@@ -187,13 +186,13 @@ from ag_ui.core import RunAgentInput, UserMessage
187186
async def main():
188187
# Setup
189188
my_agent = Agent(name="assistant", instruction="You are a helpful assistant.")
190-
189+
191190
agent = ADKAgent(
192191
adk_agent=my_agent,
193-
app_name="demo_app",
192+
app_name="demo_app",
194193
user_id="demo"
195194
)
196-
195+
197196
# Create input
198197
input = RunAgentInput(
199198
thread_id="thread_001",
@@ -206,7 +205,7 @@ async def main():
206205
tools=[],
207206
forwarded_props={}
208207
)
209-
208+
210209
# Run and handle events
211210
async for event in agent.run(input):
212211
print(f"Event: {event.type}")

integrations/community/spring-ai/typescript/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,6 @@ const result = await agent.runAgent({
3939
## To run the example server in the dojo
4040

4141
```bash
42-
cd typescript-sdk/integrations/llamaindex/server-py
42+
cd integrations/llama-index/python/examples
4343
uv sync && uv run dev
4444
```

integrations/crew-ai/typescript/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,6 @@ const result = await agent.runAgent({
3939
## To run the example server in the dojo
4040

4141
```bash
42-
cd typescript-sdk/integrations/crewai/python
42+
cd integrations/crew-ai/python
4343
poetry install && poetry run dev
4444
```

integrations/langgraph/python/examples/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ First, make sure to create a new .env file from the .env.example and include the
66

77
To run the Python examples for langgraph platform, run:
88
```
9-
cd typescript-sdk/integrations/langgraph/examples/python
9+
cd integrations/langgraph/python/examples
1010
pnpx @langchain/langgraph-cli@latest dev
1111
```
1212

1313
To run the python examples using FastAPI, run:
1414
```
15-
cd typescript-sdk/integrations/langgraph/examples/python
15+
cd integrations/langgraph/python/examples
1616
poetry install
1717
poetry run dev
1818
```

0 commit comments

Comments
 (0)