docs: rewrite Agent UI guide — lead with features, not plumbing#641
Merged
Conversation
github-actions
Bot
added
documentation
kovtcharov
changed the title
Restructure to show what the agent can do before install instructions: hero intro, blockquote example prompts, format-support table, sessions+ shortcuts merged into one compact section, MCP integration condensed into a CardGroup. User-visible additions: - Uninstall instructions (npm + Python CLI) with ~/.gaia cleanup - Three install paths (Desktop installer / npm / Python CLI), with the desktop installer first as the simplest path for non-developers - LLM-timeout troubleshooting accordion (covers the slow-response symptom caused by misconfigured MCP servers) - Video-demo placeholder (commented out until asset is uploaded) - Cross-link to /guides/memory so users discover the opt-in memory feature - Policy Alerts and Receipts section explaining how governance-blocked tool calls surface in the UI Fixes / corrections: - Missing --ui flag in port troubleshooting example - Windows-compatible commands (Get-Content vs cat) in troubleshooting - Node.js requirement bumped to 20+ - Lemonade --base-url example uses port 13305 Hardware-disclaimer Note moved to the bottom so the hero intro keeps momentum on first read.
Memory ships disabled by default (memory_enabled defaults to "false" at src/gaia/ui/routers/memory.py:1570), but the guide claimed it was "active automatically" with "No setup beyond gaia chat", so first-time users following the docs saw none of the documented behavior. Add a top-of-page beta callout, a dedicated "Enable Memory" section with two enable paths (Agent UI Memory Dashboard toggle and a curl against /api/memory/settings using the X-Gaia-UI: 1 CSRF header), and reword the four other phrases that implied automatic activation (intro line 21, How It Works bullet line 90, Quick Start step line 132, Intelligent Extraction line 506). The new section has its own anchor (#enable-memory) so other guides can deep-link to it.
itomek
force-pushed
the
kalin/docs-agent-ui-guide-updates
branch
from
7850c00 to
a75e87f
Compare
The TODO placeholder for the future demo video carried a literal https://assets.amd-gaia.ai/videos/gaia-agent-ui-demo.webm URL inside a {/* JSX comment */}. util/check_doc_links.py doesn't understand JSX comments and treats the URL as a real link, then 404s because the asset hasn't been uploaded yet — blocking the docs-CI external-URL check. Replace the literal URL with a short prose TODO that still tells a future editor where the asset will live and what to swap in. No user-visible change (the block was already a comment).
itomek-amd
approved these changes
May 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrites the Agent UI guide to lead with the user experience instead of technical setup.
Structure changes:
Content additions:
Fixes:
--uiflag in port troubleshooting exampleGet-Contentvscat)Test plan
mintlify dev)/guides/mcp/client,/guides/mcp/agent-ui,/setup)assets.amd-gaia.aiCloses #1054