Skip to content

docs(ecosystem): add @openuidev/a2ui to Related Projects - #3746

Open
vishxrad wants to merge 5 commits into
a2ui-project:mainfrom
vishxrad:docs/add-openuidev-a2ui-renderer
Open

vishxrad wants to merge 5 commits into
a2ui-project:mainfrom
vishxrad:docs/add-openuidev-a2ui-renderer

Conversation

@vishxrad

@vishxrad vishxrad commented Oct 29, 2026 •

Copy link
Copy Markdown

Description

Adds thesysdev/openui (@openuidev/a2ui) to the Related Projects table in docs/public/ecosystem/renderers.md.

@openuidev/a2ui is an experimental A2UI v1.0 or later profile from the OpenUI project. It keeps the v1.0 or later lifecycle and envelopes intact (createSurface, updateDataModel, deleteSurface, actions, renderer/agent functions, errors, capabilities, data-model metadata) but represents updateComponents.components as an array of OpenUI Lang statements instead of component JSON objects. The core client is framework-agnostic (it depends on @openuidev/lang-core, not React) and validates incoming messages with exported Zod schemas, so Vue, Svelte, Angular, native or server-side hosts can drive it and supply their own rendering adapter. A React adapter (@openuidev/a2ui/react) ships with the package and renders surfaces through @openuidev/react-lang. MIT licensed.

Because the component representation differs from the Basic Catalog JSON shape, standard A2UI agents are not compatible with it out of the box, so it is listed under Related Projects rather than in the Community Renderers table, and the description says so.

Documentation-only change; no code or CHANGELOG affected.

Pre-launch Checklist

One time:

For this PR:

  • I have updated the relevant CHANGELOG.md file. (Not applicable: ecosystem docs listing.)
  • I updated/added relevant documentation.
  • My code changes (if any) have tests. (No code changes.)
  • If my branch is on a fork, I have verified that scripts/e2e_test.sh passes. (Not applicable: docs-only change.)

If you need help, consider asking for advice on the discussion board.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds the thesysdev/openui (@openuidev/a2ui) renderer to the ecosystem documentation. The feedback suggests moving this entry from the main 'Community Renderers' table to 'Related Projects' or 'Notable Mentions' because it uses OpenUI Lang statements instead of standard A2UI component JSON objects, which prevents out-of-the-box compatibility with standard A2UI agents.

Comment thread docs/public/ecosystem/renderers.md Outdated
| **ChaliceForAuri/a2ui-svelte** (`svelte-a2ui`) | Svelte 5 (Web) | ❌ | ✅ | ✅ | ![Stars](https://img.shields.io/github/stars/ChaliceForAuri/a2ui-svelte?style=flat-square&label=⭐) ![Last commit](https://img.shields.io/github/last-commit/ChaliceForAuri/a2ui-svelte?style=flat-square&label=updated) | [GitHub](https://github.com/ChaliceForAuri/a2ui-svelte) · [npm](https://www.npmjs.com/package/svelte-a2ui) · [Demo](https://chaliceforauri.github.io/a2ui-svelte/) |
| **Language-Lit/material3-expressive-a2ui** (`@language-lit/material3-expressive-a2ui`) | React + Material 3 Expressive (Web) | ❌ | ✅ | — | ![Stars](https://img.shields.io/github/stars/Language-Lit/material3-expressive-a2ui?style=flat-square&label=⭐) ![Last commit](https://img.shields.io/github/last-commit/Language-Lit/material3-expressive-a2ui?style=flat-square&label=updated) | [GitHub](https://github.com/Language-Lit/material3-expressive-a2ui) · [npm](https://www.npmjs.com/package/@language-lit/material3-expressive-a2ui) · [Demo & Docs](https://m3e.language-lit.com/a2ui/) |
| **uny/a2ui-compose** (`dev.ynagai.a2ui:a2ui-material3`) | Compose Multiplatform (Android, iOS, desktop, macOS, web JS/wasmJs) | ❌ | ❌ | ✅ | ![Stars](https://img.shields.io/github/stars/uny/a2ui-compose?style=flat-square&label=⭐) ![Last commit](https://img.shields.io/github/last-commit/uny/a2ui-compose?style=flat-square&label=updated) | [GitHub](https://github.com/uny/a2ui-compose) · [Maven Central](https://central.sonatype.com/namespace/dev.ynagai.a2ui) · [API docs](https://uny.github.io/a2ui-compose/) |
| **thesysdev/openui** (`@openuidev/a2ui`) | Framework-agnostic core + React adapter (Web) | ❌ | ❌ | ✅ | ![Stars](https://img.shields.io/github/stars/thesysdev/openui?style=flat-square&label=⭐) ![Last commit](https://img.shields.io/github/last-commit/thesysdev/openui?path=packages%2Fa2ui&style=flat-square&label=updated) | [GitHub](https://github.com/thesysdev/openui/tree/main/packages/a2ui) · [npm](https://www.npmjs.com/package/@openuidev/a2ui) · [Docs](https://www.openui.com/docs/api-reference/a2ui) |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Since @openuidev/a2ui uses OpenUI Lang statements instead of the standard A2UI component JSON objects (Basic Catalog), standard A2UI agents will not be compatible with it out of the box. Marking it as a fully compliant v1.0 or later renderer in the main table with a ✅ could be misleading to users who expect plug-and-play compatibility.

As you noted in the PR description, it would be more appropriate to list this under Related Projects or Notable Mentions rather than the main Community Renderers table, clearly highlighting that it is an experimental profile with a different component representation.

References
  1. When documenting protocol or specification versions, use 'version or later' (e.g., 'v1.0 or later') to ensure forward compatibility when describing feature availability or state.

@github-actions github-actions Bot added the status: needs-triage auto-managed: https://github.com/a2ui-project/a2ui/blob/main/scripts/triage.mjs label Oct 29, 2026
@vishxrad vishxrad changed the title docs(ecosystem): add @openuidev/a2ui community renderer docs(ecosystem): add @openuidev/a2ui to Related Projects Oct 29, 2026
@Varun-S10 Varun-S10 self-assigned this Oct 30, 2026
@Varun-S10

Copy link
Copy Markdown
Collaborator

Hi @vishxrad, Thank you for moving the entry to Related Projects. Could you please also update the version wording to v1.0 or later as noted in the bot comment reference?

@Varun-S10 Varun-S10 added status: waiting-for-author-response and removed status: needs-triage auto-managed: https://github.com/a2ui-project/a2ui/blob/main/scripts/triage.mjs labels Oct 30, 2026
@vishxrad

vishxrad commented Oct 30, 2026 •

Copy link
Copy Markdown
Author

Thanks @Varun-S10! Updated the wording to 'v1.0 or later' in d949d53.

@github-actions github-actions Bot added status: needs-triage auto-managed: https://github.com/a2ui-project/a2ui/blob/main/scripts/triage.mjs and removed status: waiting-for-author-response labels Oct 30, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: needs-triage auto-managed: https://github.com/a2ui-project/a2ui/blob/main/scripts/triage.mjs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants