Skip to content

Commit 2d961ba

Browse files
Make titles in non-docs markdown files more consistent with style guide (#552)
* Make titles in README more consistent with style guide * Update non docs/ markdown files
1 parent 34c4909 commit 2d961ba

File tree

9 files changed

+126
-135
lines changed

9 files changed

+126
-135
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ to generate or populate rich user interfaces.
99

1010
*A gallery of A2UI rendered cards, showing a variety of UI compositions that A2UI can achieve.*
1111

12-
## ⚠️ Status: Early Stage Public Preview
12+
## ⚠️ Status: Early stage public preview
1313

1414
> **Note:** A2UI is currently in **v0.8 (Public Preview)**. The specification and
1515
implementations are functional but are still evolving. We are opening the project to
@@ -30,7 +30,7 @@ component library (Flutter, Angular, Lit, etc.).
3030
This approach ensures that agent-generated UIs are
3131
**safe like data, but expressive like code**.
3232

33-
## High-Level Philosophy
33+
## High-level philosophy
3434

3535
A2UI was designed to address the specific challenges of interoperable,
3636
cross-platform, generative or template-based UI responses from agents.
@@ -63,7 +63,7 @@ places security firmly in the developer's hands, enabling them to enforce
6363
strict sandboxing policies and "trust ladders" directly within their custom
6464
component logic rather than relying solely on the core system.
6565

66-
## Use Cases
66+
## Use cases
6767

6868
Some of the use cases include:
6969

@@ -98,7 +98,7 @@ A2UI is designed to be a lightweight format, but it fits into a larger ecosystem
9898
* **Host Frameworks:** Requires a host application built in a supported framework
9999
(currently: Web or Flutter).
100100

101-
## Getting Started
101+
## Getting started
102102

103103
The best way to understand A2UI is to run the samples.
104104

@@ -108,7 +108,7 @@ The best way to understand A2UI is to run the samples.
108108
* Python (for agent samples)
109109
* A valid [Gemini API Key](https://aistudio.google.com/) is required for the samples.
110110

111-
### Running the Restaurant Finder Demo
111+
### Running the Restaurant Finder demo
112112

113113
1. **Clone the repository:**
114114

@@ -117,7 +117,7 @@ The best way to understand A2UI is to run the samples.
117117
cd A2UI
118118
```
119119

120-
2. **Set your API Key:**
120+
2. **Set your API key:**
121121

122122
```bash
123123
export GEMINI_API_KEY="your_gemini_api_key"
@@ -160,10 +160,10 @@ to try out as well.
160160

161161
We hope to work with the community on the following:
162162

163-
* **Spec Stabilization:** Moving towards a v1.0 specification.
164-
* **More Renderers:** Adding official support for React, Jetpack Compose, iOS (SwiftUI), and more.
165-
* **Additional Transports:** Support for REST and more.
166-
* **Additional Agent Frameworks:** Genkit, LangGraph, and more.
163+
* **Spec stabilization:** Moving towards a v1.0 specification.
164+
* **More renderers:** Adding official support for React, Jetpack Compose, iOS (SwiftUI), and more.
165+
* **Additional transports:** Support for REST and more.
166+
* **Additional Agent frameworks:** Genkit, LangGraph, and more.
167167

168168
## Contribute
169169

a2a_agents/python/a2ui_agent/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# A2UI Agent Implementation
1+
# A2UI Agent implementation
22

33
The `a2a_agents/python/a2ui_agent/` is the Python implementation of the a2ui agent library.
44

5-
### Extension Components (`src/a2ui/extension`)
5+
### Extension components (`src/a2ui/extension`)
66

77
The `src/a2ui/extension` directory contains the core logic for the A2UI agent extension:
88

99
* **`a2ui_extension.py`**: Core utilities for extension management and A2UI part handling.
1010
* **`a2ui_schema_utils.py`**: Schema manipulation helpers.
1111
* **`send_a2ui_to_client_toolset.py`**: An example implementation of using ADK toolcalls to implement A2UI.
1212

13-
## Running Tests
13+
## Running tests
1414

1515
1. Navigate to the a2ui_agent dir:
1616

@@ -40,4 +40,4 @@ All operational data received from an external agent—including its AgentCard,
4040

4141
Similarly, any UI definition or data stream received must be treated as untrusted. Malicious agents could attempt to spoof legitimate interfaces to deceive users (phishing), inject malicious scripts via property values (XSS), or generate excessive layout complexity to degrade client performance (DoS). If your application supports optional embedded content (such as iframes or web views), additional care must be taken to prevent exposure to malicious external sites.
4242

43-
Developer Responsibility: Failure to properly validate data and strictly sandbox rendered content can introduce severe vulnerabilities. Developers are responsible for implementing appropriate security measures—such as input sanitization, Content Security Policies (CSP), strict isolation for optional embedded content, and secure credential handling—to protect their systems and users.
43+
Developer Responsibility: Failure to properly validate data and strictly sandbox rendered content can introduce severe vulnerabilities. Developers are responsible for implementing appropriate security measures—such as input sanitization, Content Security Policies (CSP), strict isolation for optional embedded content, and secure credential handling—to protect their systems and users.

renderers/lit/README

Lines changed: 0 additions & 9 deletions
This file was deleted.

samples/agent/adk/contact_lookup/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# A2UI Contact Lookup Agent Sample
1+
# A2UI Contact Lookup Agent sample
22

33
This sample uses the Agent Development Kit (ADK) along with the A2A protocol to create a simple "Contact Lookup" agent that is hosted as an A2A server.
44

@@ -8,7 +8,7 @@ This sample uses the Agent Development Kit (ADK) along with the A2A protocol to
88
- [UV](https://docs.astral.sh/uv/)
99
- Access to an LLM and API Key
1010

11-
## Running the Sample
11+
## Running the sample
1212

1313
1. Navigate to the samples directory:
1414

@@ -38,4 +38,4 @@ All operational data received from an external agent—including its AgentCard,
3838

3939
Similarly, any UI definition or data stream received must be treated as untrusted. Malicious agents could attempt to spoof legitimate interfaces to deceive users (phishing), inject malicious scripts via property values (XSS), or generate excessive layout complexity to degrade client performance (DoS). If your application supports optional embedded content (such as iframes or web views), additional care must be taken to prevent exposure to malicious external sites.
4040

41-
Developer Responsibility: Failure to properly validate data and strictly sandbox rendered content can introduce severe vulnerabilities. Developers are responsible for implementing appropriate security measures—such as input sanitization, Content Security Policies (CSP), strict isolation for optional embedded content, and secure credential handling—to protect their systems and users.
41+
Developer Responsibility: Failure to properly validate data and strictly sandbox rendered content can introduce severe vulnerabilities. Developers are responsible for implementing appropriate security measures—such as input sanitization, Content Security Policies (CSP), strict isolation for optional embedded content, and secure credential handling—to protect their systems and users.

specification/v0_8/docs/a2ui_extension_specification.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# A2UI (Agent-to-Agent UI) Extension Spec
1+
# A2UI (Agent-to-Agent UI) Extension spec
22

33
## Overview
44

@@ -10,7 +10,7 @@ The URI of this extension is https://a2ui.org/a2a-extension/a2ui/v0.8
1010

1111
This is the only URI accepted for this extension.
1212

13-
## Core Concepts
13+
## Core concepts
1414

1515
The A2UI extension is built on the following main concepts:
1616

@@ -49,11 +49,11 @@ Example AgentExtension block:
4949
}
5050
```
5151

52-
### Parameter Definitions
52+
### Parameter definitions
5353
- `params.supportedCatalogIds`: (OPTIONAL) An array of strings, where each string is a URI pointing to a component Catalog Definition Schema that the agent can generate.
5454
- `params.acceptsInlineCatalogs`: (OPTIONAL) A boolean indicating if the agent can accept an `inlineCatalogs` array in the client's `a2uiClientCapabilities`. If omitted, this defaults to `false`.
5555

56-
## Extension Activation
56+
## Extension activation
5757
Clients indicate their desire to use the A2UI extension by specifying it via the transport-defined A2A extension activation mechanism.
5858

5959
For JSON-RPC and HTTP transports, this is indicated via the X-A2A-Extensions HTTP header.
@@ -62,7 +62,7 @@ For gRPC, this is indicated via the X-A2A-Extensions metadata value.
6262

6363
Activating this extension implies that the server can send A2UI-specific messages (like surfaceUpdate) and the client is expected to send A2UI-specific events (like userAction).
6464

65-
## Data Encoding
65+
## Data encoding
6666

6767
A2UI messages are encoded as an A2A `DataPart`.
6868

@@ -86,4 +86,4 @@ Example A2UI DataPart:
8686
"mimeType": "application/json+a2ui"
8787
}
8888
}
89-
```
89+
```

specification/v0_8/docs/a2ui_protocol.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ A Specification for a JSONL-Based, Streaming UI Protocol
1212
Created: Sep 19, 2025
1313
Updated: Nov 12, 2025
1414

15-
## Design Requirements
15+
## Design requirements
1616

1717
The A2UI (Agent to UI) protocol should be a system where an LLM can stream a platform-agnostic, abstract UI definition to a client, which then renders it progressively using a native widget set. Every major design choice is traced back to the core challenges of LLM generation, perceived performance, and platform independence.
1818

@@ -71,19 +71,19 @@ Client-to-server communication for user interactions is handled separately via a
7171
- `error`: Reports a client-side error.
7272
This keeps the primary data stream unidirectional.
7373

74-
## Section 1: Foundational Architecture and Data Flow
74+
## Section 1: Foundational architecture and data flow
7575

7676
This document specifies the architecture and data formats for the A2UI protocol. The design is guided by principles of strict separation of concerns, versioning, and progressive rendering.
7777

78-
### 1.1. Core Philosophy: Decoupling and Contracts
78+
### 1.1. Core philosophy: decoupling and contracts
7979

8080
The central philosophy of A2UI is the decoupling of three key elements:
8181

8282
1. **The Component Tree (The Structure):** A server-provided tree of abstract components that describes the UI's structure. This is defined by `surfaceUpdate` messages.
8383
2. **The Data Model (The State):** A server-provided JSON object containing the dynamic values that populate the UI, such as text, booleans, or lists. This is managed via `dataModelUpdate` messages.
8484
3. **The Widget Registry (The "Catalog"):** A client-defined mapping of component types (e.g., "Row", "Text") to concrete, native widget implementations. This registry is **part of the client application**, not the protocol stream. The server must generate components that the target client's registry understands.
8585

86-
### 1.2. The JSONL Stream: The Unit of Communication
86+
### 1.2. The JSONL stream: The unit of communication
8787

8888
All UI descriptions are transmitted from the server to the client as a stream of JSON objects, formatted as JSON Lines (JSONL). Each line is a separate, compact JSON object representing a single message. This allows the client to parse and process each part of the UI definition as it arrives, enabling progressive rendering.
8989

0 commit comments

Comments
 (0)