Skip to content

feat: assistant widget - #6754

Merged
dks333 merged 25 commits into
mainfrom
sam/assistant-widget
Jul 28, 2026
Merged

feat: assistant widget#6754
dks333 merged 25 commits into
mainfrom
sam/assistant-widget

Conversation

@dks333

@dks333 dks333 commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Documentation changes

Brief description of what's being updated

Closes


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Low Risk
Docs-site-only changes (MDX, snippets, CSS, nav); no product auth or API logic. Live preview relies on a public demo widget ID and deployed /_minimal/ routing.

Overview
Adds Assistant → Widget documentation for embedding @mintlify/assistant-widget on external sites, including dashboard setup, install patterns, custom triggers, update() behavior, full config/API reference, and CSP guidance.

The install section is wrapped in an interactive playground that tweaks appearance and hooks and emits HTML or Next.js snippets. A live preview uses a chromeless /_minimal/.../assistant/widget-preview iframe (not srcdoc) so captcha providers see a real hostname; playground.css splits the wide layout and hides docs chrome on the preview route. Playground and preview host stay in sync via postMessage.

Reviewed by Cursor Bugbot for commit 9b2d208. Bugbot is set up for automated code reviews on this repo. Configure here.

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Jul 26, 2026, 8:15 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Jul 26, 2026, 8:15 AM

Comment thread assistant-widget.js Outdated
@mintlify

mintlify Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
mintlify 🟡 Building Jul 26, 2026, 8:13 AM

@mintlify

mintlify Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
tomee 🟡 Building Jul 26, 2026, 8:13 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Comment thread assistant-widget.js Outdated
Comment thread snippets/assistant-widget-playground.jsx Outdated
Comment thread snippets/assistant-widget-preview-host.jsx
Comment thread snippets/assistant-widget-preview-host.jsx
@dks333
dks333 merged commit e10cfd0 into main Jul 28, 2026
6 checks passed
@dks333
dks333 deleted the sam/assistant-widget branch July 28, 2026 00:37

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 9b2d208. Configure here.

Comment thread playground.css
html[data-current-path="/assistant/widget"]
iframe[title="Live Assistant Widget preview"] {
height: 100%;
}

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Locale paths miss playground layout

Medium Severity

Playground layout rules use an exact data-current-path="/assistant/widget" match, so localized paths like /es/assistant/widget never get the side-by-side layout or iframe sizing. The widget-preview rules in the same file already use a suffix match specifically to cover locales, and the playground JS also parses locale segments.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 9b2d208. Configure here.

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