Skip to content

docs: README — implements A2UI v0.8 (not "inspired by")#11

Open
dzuluaga wants to merge 1 commit into
mainfrom
docs/readme-v0.8
Open

docs: README — implements A2UI v0.8 (not "inspired by")#11
dzuluaga wants to merge 1 commit into
mainfrom
docs/readme-v0.8

Conversation

@dzuluaga

Copy link
Copy Markdown
Collaborator

Summary

PR #4 made A2UI v0.8 conformance real. This PR updates the README lede to say so accurately, without overclaiming.

What changes

  • Lede now describes the actual implementation: v0.8 wire format (surfaceUpdate / beginRendering / dataModelUpdate / deleteSurface), official standard catalog (Text / Button / Row / Column / Card / CheckBox / TextField / MultipleChoice / Divider) at the canonical catalogId, plus a namespaced custom catalog (lumen.com:concierge/v1) for the three e-commerce composites (CardGrid, ProductDetail, PaymentChallenge). Links to google/A2UI and the standard catalog definition.
  • Replaces the "Five A2UI components, all written once in Lit" bullet with the two-catalog model: standard for chrome, three Lit composites for app-specific surfaces. Points readers at docs/a2ui-shapes.md.
  • Surface count: two → three (Android, iOS, web), reflecting the KMP migration that landed in PR feat(kmp): migrate Android app to Kotlin Multiplatform with iOS support #5.
  • LLM framing: "Anthropic Claude Sonnet 4.6" → "LiteLLM, defaults to Claude" — matches the configurable provider abstraction (also from migrate the project to use the official A2UI spec #4).

Why now

Hanlu flagged the original lede as overclaiming. I opened #6 with a stop-gap "inspired by" disclaimer while #4 was in flight. #4 is now merged — the framing in this PR is the right one. #6 is closed as superseded.

Test plan

  • Render GitHub markdown — links resolve, headers correct
  • google/A2UI link works
  • a2ui.org/.../standard_catalog_definition.json link works
  • docs/a2ui-shapes.md link resolves

Previously the lede oversold conformance ("A demo of the A2UI
protocol") when the repo used a flattened application envelope.
PR #4 closed that gap — the demo now genuinely emits v0.8
surfaceUpdate/beginRendering messages, uses the official standard
catalog for chrome (Text/Button/Row/Column/Card/etc.) over the
canonical catalogId, and reserves a namespaced custom catalog
(lumen.com:concierge/v1) for the three e-commerce composites.

This README update:

  • lede now describes the v0.8 implementation accurately, linking
    to google/A2UI and the official standard catalog definition
  • the "Five A2UI components" bullet is replaced with the
    two-catalog model (standard for chrome, custom for composites)
    and a pointer to docs/a2ui-shapes.md
  • surface count bumped from two to three (Android, iOS, web)
    reflecting the KMP migration in PR #5
  • model framing softened to "LiteLLM, defaults to Claude" to
    match the actual configurable provider

Closes the work tracked in #6 (which had a stop-gap "inspired by"
framing while PR #4 was open). #6 is closed as superseded.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants