-
Notifications
You must be signed in to change notification settings - Fork 626
docs for public #277
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
docs for public #277
Changes from all commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
da8b5e2
docs: full pass on documentation
zeroasterisk 7077d0d
docs: second pass on documentation
zeroasterisk f250685
Update docs/agents.md
zeroasterisk a882520
Update docs/agents.md
zeroasterisk c927529
docs: updates to root level pages
zeroasterisk 2b5a773
Update docs/concepts/components.md
zeroasterisk 1546255
Update docs/concepts/components.md
zeroasterisk 8847c3a
Commit agent changes to make docs consistent with v0.8
jacobsimionato c298c17
docs: guides/agent-dev
zeroasterisk 0d01c85
Update docs/concepts/data-binding.md
zeroasterisk 5d5d369
docs: reduce scope of concepts pages
zeroasterisk a8efaf7
Merge remote-tracking branch 'origin/main' into docs
zeroasterisk 41d067f
docs: simplifying
zeroasterisk cd3916b
update code in docs/guides
jacobsimionato bc724ec
fix: unclosed blockstring
zeroasterisk f0fc603
docs: formatting & quickstart
zeroasterisk 6fb4167
Update docs/guides/theming.md
zeroasterisk 3ea2a4b
docs: cleanup to align to v0.8
zeroasterisk 5b352fe
docs: streamline guides and remove unverified code examples
zeroasterisk 6ccd31a
update disclaimers (#284)
dmandar 474dd4a
fix build (#286)
dmandar 4b49344
Remove date from TextField component (#282)
jacobsimionato 8075e41
docs: Greg reviews
zeroasterisk ea5110d
Merge branch 'main' into docs
jacobsimionato af1ac7e
Fix broken links and add warning about npms not published yet
jacobsimionato File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Agents (Server-Side) | ||
|
|
||
| Agents are server-side programs that generate A2UI messages in response to user requests. | ||
|
|
||
| The actual component rendering is done by the [renderer](renderers.md), | ||
| after messages are [transported](transports.md) to the client. | ||
| The agent is only responsible for generating the A2UI messages. | ||
|
|
||
| ## How Agents Work | ||
|
|
||
| ``` | ||
| User Input → Agent Logic → LLM → A2UI JSON → Send to Client | ||
| ``` | ||
|
|
||
| 1. **Receive** user message | ||
| 2. **Process** with LLM (Gemini, GPT, Claude, etc.) | ||
| 3. **Generate** A2UI JSON messages as structured output | ||
| 4. **Send** to client via transport | ||
|
|
||
| User interactions from the client can be treated as new user input. | ||
|
|
||
| ## Sample Agents | ||
|
|
||
| The A2UI repository includes sample agents you can learn from: | ||
|
|
||
| - [Restaurant Finder](https://github.com/google/A2UI/tree/main/samples/agent/adk/restaurant_finder) | ||
| - Table reservations with forms | ||
| - Written with the ADK | ||
| - [Contact Lookup](https://github.com/google/A2UI/tree/main/samples/agent/adk/contact_lookup) | ||
| - Search with result lists | ||
| - Written with the ADK | ||
| - [Rizzcharts](https://github.com/google/A2UI/tree/main/samples/agent/adk/rizzcharts) | ||
| - A2UI Custom components demo | ||
| - Written with the ADK | ||
|
|
||
| ## Different types of agents you will use A2A with | ||
|
|
||
| ### 1. User Facing Agent (standalone) | ||
|
|
||
| A user facing agent is one that is directly interacted with by the user. | ||
|
|
||
| ### 2. User Facing Agent as a host for a Remote Agent | ||
|
|
||
| This is a pattern where the user facing agent is a host for one or more remote agents. The user facing agent will call the remote agent and the remote agent will generate the A2UI messages. This is a common pattern in [A2A](https://a2a-protocol.org) with the client agent calling the server agent. | ||
|
|
||
| - The user facing agent may "passthrough" the A2UI message without altering them | ||
| - The user facing agent may alter the A2UI message before sending it to the client | ||
|
|
||
| ### 3. Remote Agent | ||
|
|
||
| A remote agent is not directly a part of the user facing UI. Instead it is registered in as a remote agent and can be called by the user facing agent. This is a common pattern in [A2A](https://a2a-protocol.org) with the client agent calling the server agent. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| # Community | ||
|
|
||
| Welcome to the A2UI community! We're building the future of agent-driven interfaces together. | ||
|
|
||
| ## Get Involved | ||
|
|
||
| A2UI is an open-source project licensed under Apache 2.0. We welcome contributions from developers, researchers, and anyone interested in advancing agentic user interfaces. | ||
|
|
||
| ## Community Showcase | ||
|
|
||
| !!! info "Coming soon..." | ||
| We are considering how best to showcase community projects, examples, themes, renderers, custom components, and more. A 4 minute (or less) demo video and code sample linked in Github discussions is a great way to show off your work. | ||
|
|
||
| ## Project Partners | ||
|
|
||
| A2UI is developed in collaboration with several organizations: | ||
|
|
||
| ### Google Opal | ||
|
|
||
| [Opal](http://opal.google) lets users build, edit, and share AI mini-apps using natural language. The Opal team has been a core contributor to A2UI's development. | ||
|
|
||
| ### Flutter | ||
|
|
||
| The [GenUI SDK for Flutter](https://docs.flutter.dev/ai/genui) uses A2UI as the UI declaration format for generating dynamic, personalized UIs in Flutter applications. | ||
|
|
||
| ### Gemini Enterprise | ||
|
|
||
| A2UI is being integrated into [Gemini Enterprise](https://cloud.google.com/gemini-enterprise?e=48754805) to enable custom agents to render rich, interactive UIs within enterprise applications. | ||
|
|
||
| ### AG UI / CopilotKit | ||
|
|
||
| [AG UI](https://ag-ui.com/) and [CopilotKit](https://www.copilotkit.ai/) provide day-zero compatibility with A2UI, enabling developers to build rich, state-synced applications that render dynamic UIs from agents. | ||
|
|
||
| ### A2A | ||
|
|
||
| Google's [A2A team](https://a2a-protocol.org/) have been core contributors to A2UI's development, with support from the A2A Technical Steering Committee (TSC). | ||
|
|
||
| ### ... and more | ||
|
|
||
| There are many organizations and individuals contributing to A2UI's development. | ||
|
|
||
| If you have made signiciant contributions to A2UI, please submit your name to this list. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| We are committed to providing a welcoming and inclusive environment for everyone. All participants are expected to: | ||
|
|
||
| - Be respectful and considerate | ||
| - Welcome newcomers and help them get started | ||
| - Focus on what's best for the community | ||
| - Show empathy towards others | ||
|
|
||
| Unacceptable behavior will not be tolerated. Report concerns to the project maintainers. | ||
|
|
||
| ## Recognition | ||
|
|
||
| We appreciate all contributions! Contributors are recognized in: | ||
|
|
||
| - GitHub's contributor graph | ||
| - Release notes | ||
| - Project acknowledgments | ||
|
|
||
| Significant contributors may be invited to join the project's maintainer team. | ||
|
|
||
| ## Stay Updated | ||
|
|
||
| - **Watch the GitHub repo** for notifications | ||
| - **Star the repo** to bookmark and show support | ||
| - **Follow releases** to get notified of new versions | ||
|
|
||
| ## Ways to Contribute | ||
|
|
||
| **[github.com/google/A2UI](https://github.com/google/A2UI)** | ||
|
|
||
| - **Report Issues**: Found a bug? [Open an issue](https://github.com/google/A2UI/issues) | ||
| - **Build Renderers**: See the [roadmap](roadmap.md) for planned frameworks | ||
| - **Share Examples**: Post with `#A2UI` on X/LinkedIn, start a [discussion](https://github.com/google/A2UI/discussions) | ||
| - **Improve Docs**: PRs welcome in the `docs/` directory | ||
|
|
||
| ## Questions? | ||
|
|
||
| - Check the [documentation](introduction/what-is-a2ui.md) | ||
| - Search [GitHub Discussions](https://github.com/google/A2UI/discussions) | ||
| - Ask in [GitHub Issues](https://github.com/google/A2UI/issues) | ||
|
|
||
| Thank you for being part of the A2UI community! |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # A2UI Composer | ||
|
|
||
| Try building A2UI widgets interactively with the **CopilotKit A2UI Widget Builder**. | ||
|
|
||
| [](https://go.copilotkit.ai/A2UI-widget-builder) | ||
|
|
||
| **[Launch Widget Builder →](https://go.copilotkit.ai/A2UI-widget-builder)** | ||
|
|
||
| ## What it does | ||
|
|
||
| - Experiment with A2UI components visually | ||
| - Generate A2UI JSON by describing what you want | ||
| - See real-time previews | ||
| - Copy JSON to use in your agents | ||
|
|
||
| Built by the [CopilotKit](https://www.copilotkit.ai/) team. |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't look great on a dark mode background, but I suppose there's nothing to do about that. I don't think there's any way to select the image based on brightness mode.