Standardize W&B ARIA chat example snippet by mdlinville · Pull Request #2844 · wandb/docs

mdlinville · 2026-06-30T20:16:34Z

Description

Add a reusable Mintlify snippet for compact user-prompt and W&B ARIA response examples, document usage in AGENTS.md, and apply the pattern on custom charts, workspaces, and panels pages as proof of concept.

Open question: Do we prefer code blocks or chat bubbles? I styled the bubbles to align with the Ask AI integration in the docs.

Light mode:

Dark mode:

See HTML previews:

Fixes DOCS-2631

Testing

Local build succeeds without errors (mint dev)
Local link check succeeds without errors (mint broken-links)
PR tests succeed

Reviewer testing

Validate output formatting: Review PR preview pages for custom charts, workspaces, and panels
Validate AGENTS.md instructions make sense
Validate that the component is feasible for a TW to use

w-b-hivemind · 2026-06-30T20:17:19Z

HiveMind Sessions

8 sessions · 40m · $0.24

Session	Agent	Duration	Tokens	Cost	Lines
List Open Pull Requests on Docs Repo `d9a6345b-01bc-4c41-a06d-6678943a46b5`	claude	21s	531	$0.04	+0 -0
List Open Pull Requests on Docs `129b8e80-4951-43f0-9cf9-4c442fbbec32`	claude	7s	330	$0.02	+0 -0
Search GitHub for wandb Docs Repository `723d69ac-b2dc-43a3-91ae-49d65778472e`	claude	7s	289	$0.05	+0 -0
List Open Pull Requests on Docs Repo `72e42c8b-dbea-424f-8270-3fdb12dd2c2c`	claude	8s	313	$0.02	+0 -0
List Open Pull Requests on Docs `f6f9b376-5218-449e-897e-f79114979f1f`	claude	8s	303	$0.02	+0 -0
List Open Pull Requests on Docs Repo `2da0d8f0-ea48-4086-b54f-14717b9eecf9`	claude	9s	312	$0.02	+0 -0
List Open Pull Requests on Docs `a0c15eba-84d4-45e5-9eb4-bbcddc221792`	claude	10s	334	$0.06	+0 -0
W&B ARIA Chat Bubble Docs Component	cursor	39m	0	$0.00	+884 -439
Total		40m	2.4K	$0.24	+884 -439

View all sessions in HiveMind →

Run claude --resume d9a6345b-01bc-4c41-a06d-6678943a46b5 to pickup where you left off.

Copilot

Pull request overview

Adds a reusable MDX snippet for standardized “User prompt” + “W&B ARIA response” examples and rolls it out to a few Models App pages, while documenting the intended authoring pattern in AGENTS.md (DOCS-2631).

Changes:

Added snippets/_includes/aria-chat-example.mdx intended to render a compact ARIA prompt/response example.
Updated three docs pages to import and use <AriaChatExample prompt="..." response="..." /> as a proof of concept.
Documented the new snippet usage guidelines in AGENTS.md.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
`snippets/_includes/aria-chat-example.mdx`	Introduces the reusable ARIA chat example snippet (currently does not interpolate props).
`models/track/workspaces.mdx`	Adds an ARIA example for saving a workspace view using the new snippet.
`models/app/features/panels.mdx`	Adds an ARIA example for adding panels via the new snippet.
`models/app/features/custom-charts.mdx`	Adds an ARIA example for creating a custom chart via the new snippet.
`AGENTS.md`	Documents the intended authoring pattern for ARIA chat examples using the snippet.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

mintlify · 2026-06-30T20:23:49Z

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
wandb	🟢 Ready	View Preview	Jun 30, 2026, 8:28 PM

github-actions · 2026-06-30T20:28:40Z

📚 Mintlify Preview Links

🔗 View Full Preview

✨ Added (2 total)

📄 Pages (1)

File	Preview
`snippets/_includes/aria-chat-comparison.mdx`	Aria Chat Comparison

⚙️ Other (1)

File
`snippets/AriaChatBubbles.jsx`

📝 Changed (4 total)

📄 Pages (3)

File	Preview
`models/app/features/custom-charts.mdx`	Custom Charts
`models/app/features/panels.mdx`	Panels
`models/track/workspaces.mdx`	Workspaces

⚙️ Other (1)

File
`AGENTS.md`

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: 59237f8 at 2026-07-09 17:57:43 UTC

github-actions · 2026-06-30T20:28:58Z

🔗 Link Checker Results

✅ All links are valid!

No broken links were detected.

Checked against: https://wb-21fd5541-mlinville-docs-2631-aria-chat-snippet.mintlify.app

Copilot

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.

- Add a reusable Mintlify snippet for compact user-prompt and W&B ARIA response examples. Includes code-block and chat variants so we can decide on the best styling - Document usage in AGENTS.md - Apply the pattern on custom charts, workspaces, and panels pages as proof of concept.

ngrayluna · 2026-07-04T18:40:27Z

Nice. Thanks for doing this! Dumb question: are those the colors that branding wants us to use? The brown color doesn't feel that inviting?

mdlinville · 2026-07-08T22:24:25Z

Nice. Thanks for doing this! Dumb question: are those the colors that branding wants us to use? The brown color doesn't feel that inviting?

It's the same colors that our docs theme uses for the Mintlify agent chat dialog, in dark and light mode. I kept them aligned since it would look weird to me if they looked different. WDYT @johndmulhausen ?

johndmulhausen · 2026-07-09T17:41:42Z

I don't really love it, sadly. Why show the monospace "source" of the example chat at all? Especially with no word wrapping. Why have ARIA responses by copy/paste-able? I would have a single column approach and have the standard "right justifcation for user messages, left justification for ARIA responses" chat layout

mdlinville · 2026-07-09T17:52:23Z

I don't really love it, sadly. Why show the monospace "source" of the example chat at all? Especially with no word wrapping. Why have ARIA responses by copy/paste-able? I would have a single column approach and have the standard "right justifcation for user messages, left justification for ARIA responses" chat layout

The monospace styling is what we have today. I made a custom "chat bubbble" component and show it side-by-side with the monospace example for comparison. The lack of word wrapping is the initial thing I wanted to fix. My custom component behaves like you are describing, I think.

mdlinville requested a review from a team as a code owner June 30, 2026 20:16

mdlinville requested a review from Copilot June 30, 2026 20:16

Copilot started reviewing on behalf of mdlinville June 30, 2026 20:17 View session

Copilot AI reviewed Jun 30, 2026

View reviewed changes

Comment thread snippets/_includes/aria-chat-example.mdx Outdated

mintlify Bot deployed to staging June 30, 2026 20:28 View deployment

mdlinville requested a review from Copilot June 30, 2026 20:30

Copilot started reviewing on behalf of mdlinville June 30, 2026 20:31 View session

Copilot AI reviewed Jun 30, 2026

View reviewed changes

mintlify Bot deployed to staging June 30, 2026 20:34 View deployment

mintlify Bot deployed to staging June 30, 2026 20:49 View deployment

mintlify Bot deployed to staging June 30, 2026 21:05 View deployment

ngrayluna reviewed Jun 30, 2026

View reviewed changes

mintlify Bot deployed to staging June 30, 2026 21:43 View deployment

mintlify Bot deployed to staging June 30, 2026 22:14 View deployment

mintlify Bot deployed to staging July 1, 2026 18:07 View deployment

mintlify Bot deployed to staging July 1, 2026 18:53 View deployment

mdlinville force-pushed the mlinville/DOCS-2631-aria-chat-snippet branch from cc2a55a to d5d721f Compare July 1, 2026 18:55

mintlify Bot deployed to staging July 1, 2026 18:59 View deployment

mdlinville added 2 commits July 1, 2026 13:44

Noah's feedback

6dc1179

mdlinville force-pushed the mlinville/DOCS-2631-aria-chat-snippet branch from d5d721f to 6dc1179 Compare July 1, 2026 20:51

mintlify Bot deployed to staging July 1, 2026 21:59 View deployment

Adjust CSS for copy button positioning and contrast

d2ca9f5

mintlify Bot deployed to staging July 1, 2026 22:26 View deployment

mdlinville added 2 commits July 1, 2026 15:32

Move the copy widget within the bubble

1afbf92

Merge branch 'main' into mlinville/DOCS-2631-aria-chat-snippet

49f5651

mintlify Bot deployed to staging July 1, 2026 22:39 View deployment

mdlinville requested a review from ngrayluna July 1, 2026 22:40

mintlify Bot deployed to staging July 1, 2026 22:43 View deployment

Merge branch 'main' into mlinville/DOCS-2631-aria-chat-snippet

7dc5096

mintlify Bot deployed to staging July 2, 2026 20:46 View deployment

Merge branch 'main' into mlinville/DOCS-2631-aria-chat-snippet

5ead9aa

mdlinville requested review from johndmulhausen and removed request for ngrayluna July 8, 2026 22:15

mintlify Bot deployed to staging July 8, 2026 22:22 View deployment

Merge branch 'main' into mlinville/DOCS-2631-aria-chat-snippet

59237f8

mintlify Bot deployed to staging July 9, 2026 17:57 View deployment

Uh oh!

Conversation

mdlinville commented Jun 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing

Reviewer testing

Uh oh!

w-b-hivemind Bot commented Jun 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

HiveMind Sessions

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

mintlify Bot commented Jun 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jun 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📚 Mintlify Preview Links

✨ Added (2 total)

📄 Pages (1)

📝 Changed (4 total)

📄 Pages (3)

Uh oh!

github-actions Bot commented Jun 30, 2026

🔗 Link Checker Results

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ngrayluna commented Jul 4, 2026

Uh oh!

mdlinville commented Jul 8, 2026

Uh oh!

johndmulhausen commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mdlinville commented Jul 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mdlinville commented Jun 30, 2026 •

edited

Loading

w-b-hivemind Bot commented Jun 30, 2026 •

edited

Loading

mintlify Bot commented Jun 30, 2026 •

edited

Loading

github-actions Bot commented Jun 30, 2026 •

edited

Loading

johndmulhausen commented Jul 9, 2026 •

edited

Loading