Skip to content

docs: Replace agent-and-renderer.png by a Mermaid diagram.#1464

Merged
ditman merged 3 commits into
a2ui-project:mainfrom
ditman:remove-agent-and-renderer-png
Jun 3, 2026
Merged

docs: Replace agent-and-renderer.png by a Mermaid diagram.#1464
ditman merged 3 commits into
a2ui-project:mainfrom
ditman:remove-agent-and-renderer-png

Conversation

@ditman
Copy link
Copy Markdown
Collaborator

@ditman ditman commented May 20, 2026

Description

There's a diagram in the glossary that doesn't look that great:

agent-and-renderer

I replaced it by the following Mermaid diagram:

Screenshot 2026-05-19 at 6 32 39 PM

(Mermaid is already used in the "Renderer Stack" section of the glossary)

Pre-launch Checklist

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

@ditman
Copy link
Copy Markdown
Collaborator Author

ditman commented May 20, 2026

@polina-c is there any reason why the Glossary page is not linked from the left-hand side menu of the page? I think it'd be a good fit under the "Concepts" section? (I can modify the mkdocs.yaml in this PR to add it, so it's easier to find!)

Copy link
Copy Markdown
Contributor

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

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 replaces a static image in the glossary documentation with a Mermaid sequence diagram to illustrate the A2UI protocol flow. The reviewer suggested refining the diagram's loop name and adding an explicit note for data updates to better align with the textual description.

Comment thread docs/concepts/glossary.md
@polina-c
Copy link
Copy Markdown
Collaborator

polina-c commented Jun 2, 2026

@polina-c is there any reason why the Glossary page is not linked from the left-hand side menu of the page? I think it'd be a good fit under the "Concepts" section? (I can modify the mkdocs.yaml in this PR to add it, so it's easier to find!)

No reasons. Feel free to link it in this pr. Thank you for improvements!

Copy link
Copy Markdown
Collaborator

@polina-c polina-c left a comment

Choose a reason for hiding this comment

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

LGTM!

@ditman
Copy link
Copy Markdown
Collaborator Author

ditman commented Jun 2, 2026

I'll rebase this and add the link. Thanks for the review @polina-c!

@ditman ditman force-pushed the remove-agent-and-renderer-png branch from c37be1d to 3474293 Compare June 2, 2026 20:56
@ditman ditman force-pushed the remove-agent-and-renderer-png branch from 937504e to efe869f Compare June 3, 2026 20:57
@ditman ditman merged commit 73d5ff3 into a2ui-project:main Jun 3, 2026
22 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in A2UI Jun 3, 2026
@ditman ditman deleted the remove-agent-and-renderer-png branch June 3, 2026 21:13
gspencergoog pushed a commit to gspencergoog/A2UI that referenced this pull request Jun 3, 2026
…ect#1464)

* docs: Replace agent-and-renderer.png by a Mermaid diagram.
* docs: Add Glossary menu entry under Concepts
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