Standardize W&B ARIA chat example snippet#2844
Conversation
HiveMind Sessions1 session · 39m · $0.00
|
There was a problem hiding this comment.
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.mdxintended 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.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
📚 Mintlify Preview Links✨ Added (2 total)📄 Pages (1)
⚙️ Other (1)
📝 Changed (4 total)📄 Pages (3)
⚙️ Other (1)
🤖 Generated automatically when Mintlify deployment succeeds |
🔗 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 |
cc2a55a to
d5d721f
Compare
- 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.
d5d721f to
6dc1179
Compare
|
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? |
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
mint dev)mint broken-links)Reviewer testing