docs: reorganize files to match nav sections, add ADK + comparison updates#776
docs: reorganize files to match nav sections, add ADK + comparison updates#776zeroasterisk merged 17 commits intogoogle:mainfrom
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
There was a problem hiding this comment.
Code Review
This pull request effectively reorganizes the documentation by moving files into new directories that align with the navigation structure. It also includes significant content updates, such as rewriting the "How Does A2UI Compare?" page and adding a new section for the Google Agent Development Kit (ADK). All file moves are accompanied by corresponding link updates and redirects in mkdocs.yaml to prevent broken links. My review identified a couple of links in the documentation that could be improved for accuracy and specificity. Overall, this is a great improvement to the documentation's structure and content.
- Move catalogs, transports, client_to_server_actions → concepts/ - Move renderers, agents → reference/ - Move where-is-it-used, community → ecosystem/ - Rewrite agent-ui-ecosystem as concise 'How Does A2UI Compare?' intro page - Move third-party integrations (json-render, OpenClaw) to ecosystem - Fix all cross-references for moved files - Remove duplicate nav entries (each page appears once)
- native-first → declarative UI, clarify host controls styling - MCP Apps: clarify remote controls content, config via tool calling - AG UI: credit CopilotKit team, React renderer, Composer contributions - ChatKit: note shared design philosophy (basic components, declarative)
ADK Web has native A2UI rendering and A2A↔A2UI message conversion. Links to ADK docs, adk-web repo, and agent development guide.
React renderer PR google#542 is still open and not by CopilotKit. Composer was contributed by maxkorp (@CopilotKit).
Old URLs now redirect to new locations: - catalogs, transports, actions → concepts/ - renderers, agents → reference/ - community → ecosystem/ - where-is-it-used → ecosystem/a2ui-in-the-world
- React renderer PR google#542 merged — update status to Stable across all pages - Add React section to client-setup guide - Expand community renderer submission with step-by-step instructions - Replace community showcase placeholder with concrete guidance + sample links - Collapse duplicate partner info in community.md (points to a2ui-in-the-world) - Fix typo (signiciant → significant) - Tighten how-to-use wording, fix Angular install (add @a2ui/web-lib)
342c1e6 to
257b635
Compare
Explains what @a2ui/web-lib (web_core) provides, how Lit/Angular/React renderers use it, and why new web renderers should start from it rather than reimplementing message processing and state management.
…dates (google#776) * docs: reorganize files to match nav sections - Move catalogs, transports, client_to_server_actions → concepts/ - Move renderers, agents → reference/ - Move where-is-it-used, community → ecosystem/ - Rewrite agent-ui-ecosystem as concise 'How Does A2UI Compare?' intro page - Move third-party integrations (json-render, OpenClaw) to ecosystem - Fix all cross-references for moved files - Remove duplicate nav entries (each page appears once) * docs: refine How Does A2UI Compare page - native-first → declarative UI, clarify host controls styling - MCP Apps: clarify remote controls content, config via tool calling - AG UI: credit CopilotKit team, React renderer, Composer contributions - ChatKit: note shared design philosophy (basic components, declarative) * docs: restore comparison table as At a Glance section * docs: rename 'Where is A2UI Used?' → 'A2UI in the World' * docs: rename where-is-it-used → a2ui-in-the-world, MCP SEP-1865 citation * docs: add Google ADK section to A2UI in the World ADK Web has native A2UI rendering and A2A↔A2UI message conversion. Links to ADK docs, adk-web repo, and agent development guide. * docs: fix CopilotKit attribution — Composer yes, React renderer no React renderer PR google#542 is still open and not by CopilotKit. Composer was contributed by maxkorp (@CopilotKit). * docs: React renderer status — In Review, link to PR google#542 * docs: add redirects for all moved files Old URLs now redirect to new locations: - catalogs, transports, actions → concepts/ - renderers, agents → reference/ - community → ecosystem/ - where-is-it-used → ecosystem/a2ui-in-the-world * docs: React renderer merged, contribution guide, writing fixes - React renderer PR google#542 merged — update status to Stable across all pages - Add React section to client-setup guide - Expand community renderer submission with step-by-step instructions - Replace community showcase placeholder with concrete guidance + sample links - Collapse duplicate partner info in community.md (points to a2ui-in-the-world) - Fix typo (signiciant → significant) - Tighten how-to-use wording, fix Angular install (add @a2ui/web-lib) * docs: add web_core shared library section to renderer development guide Explains what @a2ui/web-lib (web_core) provides, how Lit/Angular/React renderers use it, and why new web renderers should start from it rather than reimplementing message processing and state management. * docs: link renderer names to source in client-setup table * docs: remove stars and last-updated columns from community renderers table * docs: fix ChatKit link to point to actual docs instead of openai.com homepage * docs: add live shields.io badges for stars and last-commit to community renderers * docs: fix broken React sample link, fix relative path in ecosystem --------- Co-authored-by: Zaf <zaf@0-a.org>
Summary
Reorganizes documentation files to match their navigation sections, updates content for React renderer launch, improves community contribution guidance, and adds the
web_coreshared library section to the renderer development guide.File Moves
docs/docs/concepts/docs/docs/concepts/docs/docs/concepts/docs/docs/reference/docs/docs/reference/docs/docs/ecosystem/docs/introduction/docs/ecosystem/a2ui-in-the-world.mdAll old URLs redirect via
mkdocs-redirectsplugin.Content Updates
React renderer merged (#542)
Renderer development guide
web_core" — explains the shared library that Lit, Angular, and React all build on, with import examples and version support tableCommunity & ecosystem
Comparison & positioning
Links & tables
No structural nav changes
The nav section names and ordering are unchanged. Only file paths were updated to match.