Skip to content

docs: expand AG-UI A2UI guide#1709

Draft
samjulien wants to merge 2 commits into
a2ui-project:mainfrom
samjulien:ag-ui-docs-google-sync
Draft

docs: expand AG-UI A2UI guide#1709
samjulien wants to merge 2 commits into
a2ui-project:mainfrom
samjulien:ag-ui-docs-google-sync

Conversation

@samjulien

@samjulien samjulien commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add a top-level AG-UI + A2UI any-framework guide with AG-UI CLI setup, an app/framework selector, agent skills guidance, and framework-specific setup snippets
  • add demo media for the guide: the top video defaults to the A2UI demo, switches to the Slack demo when Slack is selected, and is centered at 75% width on desktop
  • update homepage, README, and nav labels so the original Quickstart and the any-framework guide are distinct

Notes

  • The framework selector preserves the selected framework across MkDocs Material re-inits/hash navigation so TOC clicks do not reset the selected snippet.
  • Framework-specific headings are styled as panel titles instead of Markdown headings so hidden framework panels do not appear in the TOC.

Verification

  • npx --yes prettier@^3.5.0 --write docs/guides/a2ui-with-any-agent-framework.md
  • git diff --check
  • mkdocs build

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation to guide users on integrating A2UI with various agent frameworks and harnesses using AG-UI. It updates the README, index, and mkdocs configuration, and rewrites the integration guide to include a framework selector and code snippets for ADK, LangGraph, Mastra, Strands, CrewAI, Google Chat, Slack, and Teams. The review feedback highlights several issues in the new documentation, including incorrect relative asset paths, invalid Gemini model identifiers, and a nested list issue where a tool-retrieval function already returning a list was unnecessarily wrapped in another list.

</div>

<video width="100%" height="auto" controls playsinline preload="metadata" style="display: block; aspect-ratio: 16/9; object-fit: cover; border-radius: 8px; margin: 24px 0;">
<source src="../../assets/ag-ui-a2ui-demo.mp4" type="video/mp4">

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The relative path to the asset folder from docs/guides/a2ui-with-any-agent-framework.md should be ../assets/ instead of ../../assets/ because the file is located at a depth of two levels under the docs directory.

Suggested change
<source src="../../assets/ag-ui-a2ui-demo.mp4" type="video/mp4">
<source src="../assets/ag-ui-a2ui-demo.mp4" type="video/mp4">

Slack adapter already implements this pattern:

<video width="100%" height="auto" controls playsinline preload="metadata" style="display: block; aspect-ratio: 16/9; object-fit: cover; border-radius: 8px; margin: 24px 0;">
<source src="../../assets/ag-ui-slack-demo.mp4" type="video/mp4">

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The relative path to the asset folder from docs/guides/a2ui-with-any-agent-framework.md should be ../assets/ instead of ../../assets/ because the file is located at a depth of two levels under the docs directory.

Suggested change
<source src="../../assets/ag-ui-slack-demo.mp4" type="video/mp4">
<source src="../assets/ag-ui-slack-demo.mp4" type="video/mp4">

from langgraph.prebuilt import ToolNode

gemini = ChatGoogleGenerativeAI(
model="gemini-3.1-pro",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

gemini-3.1-pro is not a valid Gemini model name. Since thinking_budget is configured, please use a model that supports thinking, such as gemini-2.0-flash.

Suggested change
model="gemini-3.1-pro",
model="gemini-2.0-flash",

async def chat(self):
response = await copilotkit_stream(
await acompletion(
model="gemini/gemini-3.1-pro",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

gemini/gemini-3.1-pro is not a valid Gemini model identifier in LiteLLM. Please use a valid model identifier such as gemini/gemini-2.0-flash.

Suggested change
model="gemini/gemini-3.1-pro",
model="gemini/gemini-2.0-flash",

Comment on lines +179 to +180
a2ui_tool = get_a2ui_tools({"model": gemini})
TOOLS = [a2ui_tool]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

get_a2ui_tools returns a list of tools. Wrapping it in a list [a2ui_tool] creates a nested list [[tool1, tool2, ...]], which will cause issues when passed to ToolNode. Assign the returned list directly to TOOLS.

Suggested change
a2ui_tool = get_a2ui_tools({"model": gemini})
TOOLS = [a2ui_tool]
TOOLS = get_a2ui_tools({"model": gemini})

@samjulien samjulien force-pushed the ag-ui-docs-google-sync branch 3 times, most recently from 0f92fd6 to 9acd77f Compare June 19, 2026 03:42
@samjulien samjulien changed the title docs: add AG-UI A2UI quickstart docs: expand AG-UI A2UI guide Jun 19, 2026
@samjulien samjulien force-pushed the ag-ui-docs-google-sync branch from 9acd77f to 6ab3d83 Compare June 23, 2026 21:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant