diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 751ebd0c0d..8dfdab5ec3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -21,5 +21,5 @@ If you need help, consider asking for advice on the [discussion board]. [CHANGELOG]: ../CHANGELOG.md [CLA]: https://cla.developers.google.com/ [Contributors Guide]: ../CONTRIBUTING.md -[discussion board]: https://github.com/google/A2UI/discussions +[discussion board]: https://github.com/a2ui-project/a2ui/discussions [Style Guide]: ../CONTRIBUTING.md#coding-style diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 76802562db..c7cb62e2fd 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -39,7 +39,7 @@ jobs: contents: write actions: read - if: github.repository == 'google/A2UI' + if: github.repository == 'a2ui-project/a2ui' steps: - name: Checkout Code diff --git a/.github/workflows/e2e_test.yaml b/.github/workflows/e2e_test.yaml index a8bed42dd6..ef77883677 100644 --- a/.github/workflows/e2e_test.yaml +++ b/.github/workflows/e2e_test.yaml @@ -15,7 +15,7 @@ jobs: e2e_test: # Do not run on forked branches, # because the test does not have access to secrets in forks. - if: github.repository == 'google/a2ui' + if: github.repository == 'a2ui-project/a2ui' runs-on: ubuntu-latest permissions: contents: read diff --git a/README.md b/README.md index cc6b87980d..1475d6382a 100644 --- a/README.md +++ b/README.md @@ -114,8 +114,8 @@ Pick the path that matches where you want to start: Prerequisites: Node.js 18+, [uv](https://docs.astral.sh/uv/), and a [Gemini API key](https://aistudio.google.com/apikey). ```bash -git clone https://github.com/google/A2UI.git -cd A2UI +git clone https://github.com/a2ui-project/a2ui.git +cd a2ui export GEMINI_API_KEY="your_gemini_api_key" cd samples/client/lit npm run demo:restaurant diff --git a/agent_sdks/agent_sdk_guide.md b/agent_sdks/agent_sdk_guide.md index 22e94d68dc..80b16d3696 100644 --- a/agent_sdks/agent_sdk_guide.md +++ b/agent_sdks/agent_sdk_guide.md @@ -262,7 +262,7 @@ Create the helper utilities to wrap JSON in transport Parts (if needed for your ### Step 5: Sample Applications -Create a simple sample (like a command-line agent or local server) to verify that the SDK works end-to-end. Refer to the reference Python samples (e.g., `samples/agent/adk/contact_lookup`) for inspiration. +Create a simple sample (like a command-line agent or local server) to verify that the SDK works end-to-end. Refer to the reference Python samples (e.g., `samples/agent/adk/restaurant_finder`) for inspiration. > [!IMPORTANT] > Keep the SDK idiomatic to your language. Don't force Python-isms if it doesn't make sense (e.g., use builder patterns in Java/Kotlin or macros in C++ if they are more ergonomic). diff --git a/docs/ecosystem/a2ui-in-the-world.md b/docs/ecosystem/a2ui-in-the-world.md index 234301c47d..d8e41f80c5 100644 --- a/docs/ecosystem/a2ui-in-the-world.md +++ b/docs/ecosystem/a2ui-in-the-world.md @@ -80,7 +80,7 @@ ADK integrated the A2UI v0.8 basic catalog to automatically render spec-complian - **Built-in rendering**: ADK Web renders A2UI components natively in the dev UI. - **A2A integration**: A2UI messages are converted between A2A DataPart metadata and ADK events. -- **Agent SDK**: The [A2UI Python agent SDK](https://github.com/google/A2UI/tree/main/agent_sdks/python) provides an ADK extension for generating A2UI from agents. +- **Agent SDK**: The [A2UI Python agent SDK](https://github.com/a2ui-project/a2ui/tree/main/agent_sdks/python) provides an ADK extension for generating A2UI from agents. **Try it:** @@ -165,17 +165,12 @@ The A2UI community is building exciting projects: ### Open Source Examples -- **Restaurant Finder** ([samples/agent/adk/restaurant_finder](https://github.com/google/A2UI/tree/main/samples/agent/adk/restaurant_finder)) +- **Restaurant Finder** ([samples/agent/adk/restaurant_finder](https://github.com/a2ui-project/a2ui/tree/main/samples/agent/adk/restaurant_finder)) - Table reservation with dynamic forms - Gemini-powered agent - Full source code available -- **Contact Lookup** ([samples/agent/adk/contact_lookup](https://github.com/google/A2UI/tree/main/samples/agent/adk/contact_lookup)) - - Search interface with results list - - A2A agent example - - Demonstrates data binding - -- **Component Gallery** ([samples/client/angular - gallery mode](https://github.com/google/A2UI/tree/main/samples/client/angular)) +- **Component Gallery** ([samples/client/angular - gallery mode](https://github.com/a2ui-project/a2ui/tree/main/samples/client/angular)) - Interactive showcase of all components - Live examples with code - Great for learning @@ -202,4 +197,4 @@ For more information, see the following resources: --- -**Using A2UI in production?** Share your story on [GitHub Discussions](https://github.com/google/A2UI/discussions). +**Using A2UI in production?** Share your story on [GitHub Discussions](https://github.com/a2ui-project/a2ui/discussions). diff --git a/docs/ecosystem/community.md b/docs/ecosystem/community.md index d904381c3f..db2d3556fc 100644 --- a/docs/ecosystem/community.md +++ b/docs/ecosystem/community.md @@ -10,16 +10,15 @@ A2UI is an open-source project licensed under Apache 2.0. Contributions are welc Built something with A2UI? Show it off! -The best way to share your work is to **post in [GitHub Discussions](https://github.com/google/A2UI/discussions)** with a short description, a link to your code, and a demo video (4 minutes or less). Notable projects are featured in the docs and release notes. +The best way to share your work is to **post in [GitHub Discussions](https://github.com/a2ui-project/a2ui/discussions)** with a short description, a link to your code, and a demo video (4 minutes or less). Notable projects are featured in the docs and release notes. **Community-built renderers** are listed on the [Ecosystem Renderers](renderers.md) page — check there for community implementations and instructions for adding your own. **Official samples** in the repo are a great reference for what good A2UI projects look like: -- [Restaurant Finder](https://github.com/google/A2UI/tree/main/samples/agent/adk/restaurant_finder) — ADK agent with dynamic forms. -- [Contact Lookup](https://github.com/google/A2UI/tree/main/samples/agent/adk/contact_lookup) — search UI with data binding. -- [Angular client](https://github.com/google/A2UI/tree/main/samples/client/angular) — gallery + restaurant client. -- [Lit shell](https://github.com/google/A2UI/tree/main/samples/client/lit/shell) — minimal web component client. +- [Restaurant Finder](https://github.com/a2ui-project/a2ui/tree/main/samples/agent/adk/restaurant_finder) — ADK agent with dynamic forms. +- [Angular client](https://github.com/a2ui-project/a2ui/tree/main/samples/client/angular) — gallery + restaurant client. +- [Lit shell](https://github.com/a2ui-project/a2ui/tree/main/samples/client/lit/shell) — minimal web component client. ## Project Partners @@ -58,11 +57,11 @@ To stay informed about project updates: ## Ways to Contribute -**[github.com/google/A2UI](https://github.com/google/A2UI)** +**[github.com/a2ui-project/a2ui](https://github.com/a2ui-project/a2ui)** -- **Report Issues**: Found a bug? [Open an issue](https://github.com/google/A2UI/issues). +- **Report Issues**: Found a bug? [Open an issue](https://github.com/a2ui-project/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). +- **Share Examples**: Post with `#A2UI` on X/LinkedIn, start a [discussion](https://github.com/a2ui-project/a2ui/discussions). - **Improve Docs**: PRs welcome in the `docs/` directory. ## Questions? @@ -70,7 +69,7 @@ To stay informed about project updates: If you have 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). +- Search [GitHub Discussions](https://github.com/a2ui-project/a2ui/discussions). +- Ask in [GitHub Issues](https://github.com/a2ui-project/a2ui/issues). Thank you for being part of the A2UI community! diff --git a/docs/ecosystem/renderers.md b/docs/ecosystem/renderers.md index c3433f4971..b0342d2649 100644 --- a/docs/ecosystem/renderers.md +++ b/docs/ecosystem/renderers.md @@ -43,7 +43,7 @@ These projects are not directly A2UI renderers but are closely related and do su ### Highlights -**easyops-cn/a2ui-sdk** (`@a2ui-sdk/react`) is the most fully-featured community React renderer, with 11 published versions, Radix UI primitives, Tailwind CSS styling, and a dedicated docs site. It was [announced on the A2UI discussions](https://github.com/google/A2UI/discussions/489). For the official A2UI React renderer, see [`@a2ui/react`](https://www.npmjs.com/package/@a2ui/react). +**easyops-cn/a2ui-sdk** (`@a2ui-sdk/react`) is the most fully-featured community React renderer, with 11 published versions, Radix UI primitives, Tailwind CSS styling, and a dedicated docs site. It was [announced on the A2UI discussions](https://github.com/a2ui-project/a2ui/discussions/489). For the official A2UI React renderer, see [`@a2ui/react`](https://www.npmjs.com/package/@a2ui/react). **lmee/A2UI-Android** fills an important gap — it's currently the only Jetpack Compose renderer, covering Android 5.0+ with 20+ components, data binding, and accessibility support. @@ -61,12 +61,12 @@ If you have built an A2UI renderer, submit it to be listed here. To submit a renderer, follow these steps: -1. **Fork** the [google/A2UI](https://github.com/google/A2UI) repository +1. **Fork** the [a2ui-project/a2ui](https://github.com/a2ui-project/a2ui) repository 2. **Edit** this file (`docs/ecosystem/renderers.md`) — add a row to the Community Renderers table with your renderer's name, platform, npm package (if any), version support, and a link to the source -3. **Open a PR** against `google/A2UI` with a short description of your renderer -4. **Post in [GitHub Discussions](https://github.com/google/A2UI/discussions)** — let the community know what you built! A short demo video goes a long way. +3. **Open a PR** against `a2ui-project/a2ui` with a short description of your renderer +4. **Post in [GitHub Discussions](https://github.com/a2ui-project/a2ui/discussions)** — let the community know what you built! A short demo video goes a long way. -Need inspiration? Browse the **[community samples](https://github.com/google/A2UI/tree/main/samples)** in the repo — these cover Angular, Lit, and ADK-based agents and are a good starting point. +Need inspiration? Browse the **[community samples](https://github.com/a2ui-project/a2ui/tree/main/samples)** in the repo — these cover Angular, Lit, and ADK-based agents and are a good starting point. ### What makes a good community renderer? diff --git a/docs/guides/a2ui-in-mcp-apps.md b/docs/guides/a2ui-in-mcp-apps.md index d453d56151..50d19157ca 100644 --- a/docs/guides/a2ui-in-mcp-apps.md +++ b/docs/guides/a2ui-in-mcp-apps.md @@ -12,7 +12,7 @@ This guide shows you how to serve rich, interactive A2UI interfaces within [MCP ## Quick Start: Run the Sample -For detailed instructions on how to run this sample, please refer to the [README.md](https://github.com/google/A2UI/blob/main/samples/mcp/a2ui-in-mcpapps/README.md). +For detailed instructions on how to run this sample, please refer to the [README.md](https://github.com/a2ui-project/a2ui/blob/main/samples/mcp/a2ui-in-mcpapps/README.md). ## Architecture Overview @@ -153,7 +153,7 @@ To build your own MCP App with A2UI capabilities, follow these steps: MCP Apps are typically delivered as a single HTML resource from the MCP Server. To achieve this with a modern framework like Angular or React: 1. Build your application normally to produce static assets (`index.html`, `.js`, `.css`). -2. Use a post-build script (like the [`inline.js`](https://github.com/google/A2UI/blob/main/samples/mcp/a2ui-in-mcpapps/server/apps/src/inline.js) script in the sample) to read the `index.html` and replace external `