You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-`agent_sdks/`: Contains source code for Agent integrations.
31
+
-`python/`: Python implementation of the A2UI agent library.
32
+
-`kotlin/`: Kotlin implementation of the A2UI agent library.
33
+
-`renderers/`: Contains renderer libraries.
34
+
-`lit/`: The shared Lit renderer library used by the Lit clients.
35
+
-`angular/`: The shared Angular renderer library used by the Angular clients.
36
+
-`web_core/`: The shared core library used by web renderers.
37
+
-`markdown/`: Markdown rendering utilities.
38
+
-`tools/`: Helper tools for development.
39
+
-`editor/`: A web-based editor for generating and visualizing A2UI.
40
+
-`inspector/`: A web-based inspector for A2UI responses.
41
+
-`composer/`: Visual composer tool.
42
+
-`build_catalog/`: Catalog building utility.
43
43
44
44
## A2UI Specification Overview
45
45
@@ -49,17 +49,17 @@ The A2UI protocol is a JSONL-based, streaming UI protocol designed to be easily
49
49
50
50
The core concepts of the A2UI protocol are detailed in the main specification document. Refer to the authoritative source for the current version (0.9):
@@ -82,6 +82,7 @@ The Lit clients are located in `samples/client/lit/`.
82
82
83
83
1.**Build the Renderer**:
84
84
First, ensure the shared renderers are built:
85
+
85
86
```bash
86
87
cd renderers/markdown/markdown-it
87
88
npm install
@@ -109,6 +110,7 @@ The Lit clients are located in `samples/client/lit/`.
109
110
The Angular clients are located in`samples/client/angular/`.
110
111
111
112
First, ensure the shared renderers are built (if not already done):
113
+
112
114
```bash
113
115
cd renderers/markdown/markdown-it
114
116
npm install
@@ -124,6 +126,7 @@ npm run build
124
126
```
125
127
126
128
Then run the Angular client:
129
+
127
130
```bash
128
131
cd samples/client/angular
129
132
npm install
@@ -132,25 +135,25 @@ npm start -- contact # Replace 'contact' with the desired project name (e.g., r
132
135
133
136
### Running Tools
134
137
135
-
- **Editor**: Located in`tools/editor`. Run with `npm install && npm run dev`.
136
-
- Requires a Gemini API key in`.env` (`GEMINI_API_KEY=<key>`).
137
-
- **Inspector**: Located in`tools/inspector`. Run with `npm install && npm run dev`.
138
+
- **Editor**: Located in`tools/editor`. Run with `npm install && npm run dev`.
139
+
- Requires a Gemini API key in`.env` (`GEMINI_API_KEY=<key>`).
140
+
- **Inspector**: Located in`tools/inspector`. Run with `npm install && npm run dev`.
138
141
139
142
## Renderers
140
143
141
144
There are three renderers available for A2UI:
142
145
143
-
- **Web (Lit)**: Located in`renderers/lit`, this is the primary web renderer used by the demos in`web/`.
144
-
- **Angular**: Located in`renderers/angular`, this is an alternative web renderer for Angular applications.
145
-
- **Flutter**: The Flutter renderer is in a separate repository: [https://github.com/flutter/genui](https://github.com/flutter/genui). There is a placeholder renderer folder with a README.md file at `renderers/flutter`.
146
+
- **Web (Lit)**: Located in`renderers/lit`, this is the primary web renderer used by the demos in`web/`.
147
+
- **Angular**: Located in`renderers/angular`, this is an alternative web renderer for Angular applications.
148
+
- **Flutter**: The Flutter renderer is in a separate repository: [https://github.com/flutter/genui](https://github.com/flutter/genui). There is a placeholder renderer folder with a README.md file at `renderers/flutter`.
146
149
147
150
## Keeping This Guide Updated
148
151
149
152
This document is intended to be a living guide for the repository. As the repository evolves, it's important to keep this file up-to-date. When making changes to the repository, please consider the following:
150
153
151
-
- **New Demos or Clients**: If you add a new demo or client in `samples/`, add it to the "Running the Demos" section.
152
-
- **Specification Changes**: If you make significant changes to the A2UI protocol, ensure that the "A2UI Specification Overview" section is updated.
153
-
- **Repository Structure Changes**: If you change the directory structure of the repository, update the "Repository Structure" section.
154
+
- **New Demos or Clients**: If you add a new demo or client in `samples/`, add it to the "Running the Demos" section.
155
+
- **Specification Changes**: If you make significant changes to the A2UI protocol, ensure that the "A2UI Specification Overview" section is updated.
156
+
- **Repository Structure Changes**: If you change the directory structure of the repository, update the "Repository Structure" section.
154
157
155
158
To get this file back in sync, you can run the following commands:
156
159
@@ -160,4 +163,4 @@ To get this file back in sync, you can run the following commands:
160
163
161
164
## Change descriptions
162
165
163
-
If you (the agent) are generating a pull request summary, pull request description, or change description, avoid flowery or hyperbolic terms (e.g. "significantly improves", "greatly enhances", "is an incredible improvement"). Be factual and avoid marketing language: you're not selling the PR, you're describing it.
166
+
If you (the agent) are generating a pull request summary, pull request description, or change description, avoid flowery or hyperbolic terms (e.g. "significantly improves", "greatly enhances", "is an incredible improvement"). Be factual and avoid marketing language: you're not selling the PR, you're describing it.
0 commit comments