Skip to content

Standardize W&B ARIA chat example snippet#2844

Open
mdlinville wants to merge 6 commits into
mainfrom
mlinville/DOCS-2631-aria-chat-snippet
Open

Standardize W&B ARIA chat example snippet#2844
mdlinville wants to merge 6 commits into
mainfrom
mlinville/DOCS-2631-aria-chat-snippet

Conversation

@mdlinville

@mdlinville mdlinville commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

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:
Screenshot 2026-07-01 at 3 39 31 PM

Dark mode:
Screenshot 2026-07-01 at 3 55 03 PM

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

@mdlinville mdlinville requested a review from a team as a code owner June 30, 2026 20:16
@mdlinville mdlinville requested a review from Copilot June 30, 2026 20:16
@w-b-hivemind

w-b-hivemind Bot commented Jun 30, 2026

Copy link
Copy Markdown

HiveMind Sessions

1 session · 39m · $0.00

Session Agent Duration Tokens Cost Lines
W&B ARIA Chat Bubble Docs Component cursor 39m 0 $0.00 +884 -439
Total 39m 0 $0.00 +884 -439

View all sessions in HiveMind →

Copilot AI 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.

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.

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

mintlify Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

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

github-actions Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

📚 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: 7dc5096 at 2026-07-02 20:46:38 UTC

@github-actions

Copy link
Copy Markdown
Contributor

🔗 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 AI 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.

Pull request overview

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

Comment thread snippets/_includes/aria-chat-example.mdx Outdated
Comment thread snippets/_includes/aria-chat-example.mdx Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread models/track/workspaces.mdx Outdated
Comment thread snippets/_includes/aria-chat-example.mdx Outdated
- 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

Copy link
Copy Markdown
Contributor

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?

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.

3 participants