Merge branch 'main' into litebox-readme-update

Author: juanpabloCamus

CONTRIBUTING.md

@@ -3,6 +3,7 @@
 Thanks for your interest in improving **AG-UI**!
 
 This short guide shows the fastest way to get your idea merged.
+You can find more detailed contribution guides at [ag-ui.com](ag-ui.com) 
 
 ---
 

README.md

@@ -1,18 +1,20 @@
-[![AG-UI Workshop – June 5](https://img.shields.io/badge/AG--UI%20Workshop%20%E2%80%94June%2005-blue?style=flat-square)](https://go.copilotkit.ai/ag-ui-working-group-3)
+[![AG-UI Workshop – June 20](https://img.shields.io/badge/AG--UI%20Workshop%20%E2%80%94June%2020-blue?style=flat-square)](https://go.copilotkit.ai/ag-ui-build-an-agent-canvas)
+![Discord](https://img.shields.io/discord/1379082175625953370?logo=discord&logoColor=%23FFFFFF&label=Discord&color=%236963ff)
+
 
 # <img src="https://github.com/user-attachments/assets/ebc0dd08-8732-4519-9b6c-452ce54d8058" alt="ag-ui Logo" height="42px" /> AG-UI: The Agent-User Interaction Protocol
+AG-UI is a lightweight, event-based protocol that standardizes how AI agents connect to front-end applications. Built for simplicity and flexibility, it enables seamless integration between your AI agents and user interfaces.
 
-AG-UI is an open, lightweight, event-based protocol that standardizes **how AI agents connect to front-end applications**.
+![AG-UI](https://github.com/user-attachments/assets/bec3bc01-d8f2-4667-885e-028cbcbc8439)
 
-➡️ See demos of AG-UI-enabled applications [here](https://github.com/ag-ui-protocol/ag-ui?tab=readme-ov-file#ag-ui-compatible-agent-frameworks)
 
 <img src="./assets/banner.png" alt="ag-ui Logo" style="width: 100%; height: auto;" />
 
-# ➡️ Learn more (AG-UI Specification)
+# What is AG-UI? (Specification)
 
 AG-UI is an open, lightweight, event-based protocol for agent-human interaction, designed for simplicity & flexibility:
 
-- During agent executions, agent backends **emit events _compatible_ with one of AG-UI's 16 standard event types**
+- During agent executions, agent backends **emit events _compatible_ with one of AG-UI's ~16 standard event types**
 - Agent backends can **accept one of a few simple AG-UI compatible inputs** as arguments
 
 **AG-UI includes a flexible middleware layer** that ensures compatibility across diverse environments:
@@ -22,104 +24,105 @@ AG-UI is an open, lightweight, event-based protocol for agent-human interaction,
 
 It also ships with a **reference HTTP implementation** and **default connector** to help teams get started fast.
 
-[Learn more at docs.ag-ui.com](https://ag-ui.com)
-
-## Why AG-UI?
-
-AG-UI was developed based on real-world requirements and practical experience building in-app agent interactions.
 
-It was shaped through:
+[Learn more about the specs](https://go.copilotkit.ai/ag-ui-introduction)
 
-- Working with users in the CopilotKit community to understand the needs of agent-based interactions in applications
-- Collaborating closely with leading agent frameworks (LangGraph, Mastra, CrewAI, AG2, etc.)
-- Extracting common infrastructure patterns that emerged across varied frameworks into a standardized, open protocol
 
-This practical approach has helped ensure that AG-UI is both flexible and immediately applicable in real-world use cases.
-
-# ➡️ Build AG-UI-Powered Applications
-
-Play with this hello-world app here:
-https://agui-demo.vercel.app/
+## Why AG-UI?
 
-Video:
+AG-UI was developed based on real-world requirements and practical experience building in-app agent interactions.
 
-https://github.com/user-attachments/assets/18c03330-1ebc-4863-b2b8-cc6c3a4c7bae
+## Where does AGUI fit in the agentic protocol stack?
+AG-UI is complementary to the other 2 top agentic protocols
+- MCP gives agents tools
+- A2A allows agents to communicate with other agents
+- AG-UI brings agents into user-facing applications
 
-## Select Your Language
+<div align="center">
+  <img src="https://github.com/user-attachments/assets/0c1ec566-050b-4ef8-ab89-15be41abe64f" height="300px" />
+</div>  
+   
+## Features
 
-- [TypeScript](https://github.com/ag-ui-protocol/ag-ui/tree/main/typescript-sdk)
-- [Python](https://github.com/ag-ui-protocol/ag-ui/tree/main/python-sdk)
+- 💬 Real-time agentic chat with streaming
+- 🔄 Bi-directional state synchronization
+- 🧩 Generative UI and structured messages
+- 🧠 Real-time context enrichment
+- 🛠️ Frontend tool integration
+- 🧑‍💻 Human-in-the-loop collaboration
 
-## AG-UI Compatible Agent Frameworks
+## Framework Support
 
-AG-UI works with several popular agent frameworks and frontend solutions:
+AG-UI integrates with many popular agent frameworks
 
 | Framework                                                          | Status                   | AG-UI Resources                                                              |
 | ------------------------------------------------------------------ | ------------------------ | ---------------------------------------------------------------------------- |
-| [LangGraph](https://www.langchain.com/langgraph)                   | ✅ Supported             | ➡️ [Live Demo / Getting Started Docs](https://v0-langgraph-land.vercel.app/) |
-| [Mastra](https://mastra.ai/)                                       | ✅ Supported             | ➡️ [Live Demo / Getting Started Docs](https://v0-mastra-land.vercel.app/)    |
-| [CrewAI](https://crewai.com/)                                      | ✅ Supported             | ➡️ [Live Demo / Getting Started Docs](https://v0-crew-land.vercel.app/)      |
-| [AG2](https://ag2.ai/)                                             | ✅ Supported             | ➡️ [Live Demo / Getting Started Docs](https://v0-ag2-land.vercel.app/)       |
-| [Agno](https://github.com/agno-agi/agno)                           | 🛠️ In Progress           | –                                                                            |
-| [LlamaIndex](https://www.llamaindex.ai)                            | 🛠️ In Progress           | –                                                                            |
+| No-framework                                                       | ✅ Supported             | ➡️ Docs coming soon       |
+| [LangGraph](https://www.langchain.com/langgraph)                   | ✅ Supported             | ➡️ [Demo](https://v0-langgraph-land.vercel.app/) |
+| [Mastra](https://mastra.ai/)                                       | ✅ Supported             | ➡️ [Demo](https://v0-mastra-land.vercel.app/)    |
+| [CrewAI](https://crewai.com/)                                      | ✅ Supported             | ➡️ [Demo](https://v0-crew-land.vercel.app/)      |
+| [AG2](https://ag2.ai/)                                             | ✅ Supported             | ➡️ [Demo](https://v0-ag2-land.vercel.app/)       |
+| [Agno](https://github.com/agno-agi/agno)                           | ✅ Supported             | ➡️ [Docs](https://docs.copilotkit.ai/agno)     |                                                  |
+| [LlamaIndex](https://github.com/run-llama/llama_index)             | ✅ Supported             |   ➡️ [Docs](https://docs.copilotkit.ai/llamaindex)      |                                               |
+| [Pydantic AI](https://github.com/pydantic/pydantic-ai)             | 🛠️ In Progress           | –                                                                            |
+| [Vercel AI SDK](https://github.com/vercel/ai)                      | 🛠️ In Progress           | –                                                                            |
 | [OpenAI Agent SDK](https://openai.github.io/openai-agents-python/) | 💡 Open to Contributions | –                                                                            |
 | [Google ADK](https://google.github.io/adk-docs/get-started/)       | 💡 Open to Contributions | –                                                                            |
-| [Vercel AI SDK](https://github.com/vercel/ai)                      | 💡 Open to Contributions | –                                                                            |
 | [AWS Bedrock Agents](https://aws.amazon.com/bedrock/agents/)       | 💡 Open to Contributions | –                                                                            |
 | [Cloudflare Agents](https://developers.cloudflare.com/agents/)     | 💡 Open to Contributions | –                                                                            |
-| [Pydantic AI ](https://ai.pydantic.dev/)                           | 💡 Open to Contributions | –                                                                            |
 | [Strands Agents SDK](https://github.com/strands-agents/sdk-python) | 💡 Open to Contributions | –                                                                            |
 
 | Language SDK                                                      | Status                | AG-UI Resources                                                                 |
 | ------------------------------------------------------------------ | ------------------------ | ---------------------------------------------------------------------------- |
 | [.NET]()                                                           | 🛠️ In Progress               | ➡️ [PR](https://github.com/ag-ui-protocol/ag-ui/pull/38)                 |
 | [Nim]()                                                            | 🛠️ In Progress               | ➡️ [PR](https://github.com/ag-ui-protocol/ag-ui/pull/29)                 |
+| [Rust]()                                                           | 🛠️ In Progress               |                    |
 
-## Features
 
-AG-UI-compatible agents **securely** and **efficiently** support:
+[View all supported frameworks →](https://ag-ui.com/frameworks)
 
-- 💬 Agentic chat with real-time streaming
-- 🔄 Bi-directional state sync (in and out of chat)
-- 🧩 Generative UI and structured messages (with delta streaming)
-- 🧠 Realtime context enrichment
-- 🛠️ Frontend tool use (tool calls)
-- 🧑‍💻 Human-in-the-loop and human-on-the-loop collaboration
+## AG-UI Hello World
 
-And more. [Learn more at ag-ui.com](https://ag-ui.com)
+https://github.com/user-attachments/assets/419e4b8c-09f1-4cf0-b76b-339c7a207584
 
-## AG-UI Showcase: The AG-UI Dojo (Building-Blocks Viewer)
 
-The [ag-ui dojo](https://feature-viewer-langgraph.vercel.app/) showcases many of the building blocks that ag-ui supports.
+## AG-UI Showcase: The AG-UI Dojo (Building-Blocks Viewer)
+The [AG-UI Dojo](https://copilotkit-feature-viewer.vercel.app/) showcases many of the building blocks that AG-UI supports ([AG-UI Dojo Source Code](https://github.com/ag-ui-protocol/ag-ui/tree/main/typescript-sdk/apps/dojo)).
 
 The building blocks are designed to be simple and focused -- between 50-200 lines of code.
 
-https://github.com/user-attachments/assets/a67d3d54-36b2-4c7a-ac69-a0ca01365d5b
+[Video:](https://github.com/user-attachments/assets/18c03330-1ebc-4863-b2b8-cc6c3a4c7bae)
 
-## Client Libraries
+## Getting Started
 
-AG-UI provides ready-to-use client libraries for building connected experiences:
+Choose your path:
 
-- **React client** via [CopilotKit](https://docs.copilotkit.ai/)
-- Messaging clients (WhatsApp, WeChat, RCS) — WIP in collaboration with AWS SNS
+### Building AG-UI Powered Applications
 
-# ➡️ Contribute to AG-UI
+Create a new AG-UI application in seconds:
 
-Learn how to contribute to AG-UI: [AG-UI Contribution Guide](https://go.copilotkit.ai/agui-contribute)
+```bash
+npx create-ag-ui-app my-agent-app
+```
 
-Book time with Markus Ecker, the creator of AG-UI: https://calendly.com/markus-copilotkit/ag-ui
+[View Documentation](https://go.copilotkit.ai/ag-ui-introduction) · [Join Discord](https://discord.gg/Jd3FzfdJa8)
 
-Join the Discord: https://discord.gg/Jd3FzfdJa8
+### Building AG-UI Integrations (new frameworks)
 
-## Community
+1. [Build new integrations (Quickstart)](https://go.copilotkit.ai/build-quickstart)
+2. [Book a call to discuss an AG-UI integration with a new framework](https://go.copilotkit.ai/ag-ui-book-a-call)
+3. [Join the Discord Community](https://go.copilotkit.ai/AG-UI-Discord)
 
-### Upcoming Events
 
-- **[AG-UI: Workshop](https://go.copilotkit.ai/ag-ui-working-group-3)**  
-  📅 Friday, June 5, 9:00 AM PT  
-  🔗 [Register now](https://go.copilotkit.ai/ag-ui-working-group-3)
+## Contributing
 
 
-## Contributing
+Check out the [Contributing guide](https://github.com/ag-ui-protocol/ag-ui/blob/main/CONTRIBUTING.md)
+
+- **[AG-UI: Build an agent canvas with AG-UI](https://go.copilotkit.ai/ag-ui-build-an-agent-canvas)**  
+  📅 Friday, June 20, 9:00 AM PT  
+
+
+## License
 
-We 💜 contributions! Whether you're fixing bugs, improving documentation, or building demos — your contributions make AG-UI better.
+AG-UI is open source and available under the MIT License.

docs/development/contributing.mdx

@@ -3,5 +3,15 @@ title: Contributing
 description: How to participate in Agent User Interaction Protocol development
 ---
 
+# Naming conventions
+
+Add your package under `typescript-sdk/integrations/` with docs and tests.
+
+If your integration is work in progress, you can still add it to main branch.
+You can prefix it with `wip-`, i.e.
+(`typescript-sdk/integrations/wip-your-integration`) or if you're a third party
+contributor use the `community` prefix, i.e.
+(`typescript-sdk/integrations/community-your-integration`).
+
 For questions and discussions, please use
 [GitHub Discussions](https://github.com/orgs/ag-ui-protocol/discussions).

docs/docs.json

@@ -19,7 +19,17 @@
               "introduction",
               {
                 "group": "Quickstart",
-                "pages": ["quickstart/middleware", "quickstart/server"]
+                "pages": [
+                  "quickstart/applications",
+                  {
+                    "group": "Build integrations",
+                    "pages": [
+                      "quickstart/introduction",
+                      "quickstart/server",
+                      "quickstart/middleware"
+                    ]
+                  }
+                ]
               },
               "integrations"
             ]
@@ -104,11 +114,16 @@
     "dark": "/logo/dark.svg"
   },
   "navbar": {
-    "links": [],
+    "links": [
+      {
+        "label": "Discord",
+        "href": "https://discord.gg/Jd3FzfdJa8",
+        "icon": "server"
+      }
+    ],
     "primary": {
-      "type": "button",
-      "label": "GitHub",
-      "href": "https://github.com/ag-ui-protocol"
+      "type": "github",
+      "href": "https://github.com/ag-ui-protocol/ag-ui"
     }
   },
   "seo": {
@@ -119,7 +134,7 @@
   },
   "footer": {
     "socials": {
-      "github": "https://github.com/ag-ui-protocol"
+      "github": "https://github.com/ag-ui-protocol/ag-ui"
     }
   },
   "redirects": [

docs/quickstart/applications.mdx

@@ -0,0 +1,28 @@
+---
+title: "Build applications"
+description:
+  "Build agentic applications utilizing compatible event AG-UI event streams"
+---
+
+# Introduction
+
+AG-UI provides a concise, event-driven protocol that lets any agent stream rich,
+structured output to any client. It can be used to connect any agentic system to
+any client.
+
+A client is defined as any system that can receieve, display, and respond to 
+AG-UI events. For more information on existing clients and integrations, see
+the [integrations](/integrations) page.
+
+# Automatic Setup
+AG-UI provides a CLI tool to automatically create or scaffold a new application with any client and server.
+
+```sh
+npx create-ag-ui-app@latest
+```
+
+<img
+  className="w-full rounded-3xl mx-auto"
+  src="https://copilotkit-public-assets.s3.us-east-1.amazonaws.com/docs/ag-ui/quickstart.gif"
+/>
+

docs/quickstart/introduction.mdx

@@ -0,0 +1,68 @@
+---
+title: "Introduction"
+description: "Learn how to get started building an AG-UI integration"
+---
+
+<video
+  src="https://copilotkit-public-assets.s3.us-east-1.amazonaws.com/docs/ag-ui/ag-ui-animation-simple.mp4"
+  autoPlay
+  playsInline
+  muted
+  className="w-full h-[390px] rounded-lg object-cover mx-auto block"
+/>
+
+# What is an Integration?
+
+An AG-UI integration makes your agent speak the AG-UI protocol. This means your agent can work with any AG-UI compatible client application - like chat interfaces, copilots, or custom AI tools.
+
+Think of it like adding a universal translator to your agent. Instead of building custom APIs for each client, you implement AG-UI once and instantly work with any compatible application.
+
+Agents integrating with AG-UI can:
+- **Stream responses** - Real-time text that appears as it's generated
+- **Call client-side tools** - Your agent can use functions and services defined by clients
+- **Share state** - Your agent's state is bidirectional shared state
+- **Execute universally** - Integrate with any AG-UI compatible client application
+- **And much more!** - Check out the full specification [here](/concepts/events).
+
+### When should I make any integration?
+If the integration you're looking for is not listed on our [integrations page](/integrations), you'll need to make an integration. We've got a few guides on this below!
+
+However, if you're looking to utilize an existing integration (like LangGraph, CrewAI, Mastra, etc.), you can skip this step and go straight to [building an application](/quickstart/applications).
+
+# Types of Integrations
+So you've decided you need an integration! Great, there are **two main ways** to implement an AG-UI integration:
+
+<CardGroup cols={2}>
+  <Card
+    icon="server"
+    title="Server Implementation"
+    href="/quickstart/server"
+  >
+    Emit AG-UI events **directly from your agent** or server.
+  </Card>
+  <Card
+    icon="code"
+    title="Middleware Implementation"
+    href="/quickstart/middleware"
+  >
+    **Translate existing protocols** and applications to AG-UI events.
+  </Card>
+</CardGroup>
+
+### When to use a server implementation
+Server implementations allow you to directly emit AG-UI events from your agent or server. If you are not using an
+agent framework or haven't created a protocol for your agent framework yet, this is the best way to get started.
+
+Server implementations are also great for:
+- Building a **new agent frameworks** from scratch
+- **Maximum control** over how and what events are emitted
+- Exposing your agent as a **standalone API**
+
+### When to use a middleware implementation
+Middleware is the flexible option. It allows you to translate existing protocols and applications to AG-UI events
+creating a bridge between your existing system and AG-UI.
+
+Middleware is great for:
+- Taking your **existing protocol or API** and **translating it universally**
+- Working within the confines of **an existing system or framework**
+- **When you don't have direct control** over the agent framework or system