feat: assistant widget - #6754
Open
dks333 wants to merge 23 commits into
Open
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
ethanpalm
approved these changes
Jul 27, 2026
ethanpalm
left a comment
ethanpalm
left a comment
Collaborator
There was a problem hiding this comment.
pushed a few changes. lgtm!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation changes
Brief description of what's being updated
Closes
For Reviewers
When reviewing documentation PRs, please consider:
✅ Technical accuracy
✅ Clarity and completeness
✅ User experience
Note
Low Risk
Documentation and docs-site UI only; no production app or auth changes.
Overview
Adds assistant/widget documentation for embedding the Mintlify AI assistant on external sites via
@mintlify/assistant-widget, including enablement steps, install guidance, and a full browser API reference (init,open,ask,update, CSP, and configuration tables).The page wraps an
AssistantWidgetPlaygroundsnippet that lets readers tune appearance and hooks, copy HTML or Next.js install snippets, and see a live iframe preview (with layout guards for SPA navigation).playground.csswidens the content area on large screens so the preview can sit beside the prose.docs.jsonlinks the new page under Assistant in Optimize.Reviewed by Cursor Bugbot for commit f16e564. Bugbot is set up for automated code reviews on this repo. Configure here.