From f327f57c1daa4f804fcd368b7a0d5d3edd67bb25 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 9 Nov 2026 17:58:06 +0000 Subject: [PATCH 1/2] docs: point new widget requests to building an in-app assistant --- assistant/widget.mdx | 4 ++-- help-center/embed-docs-site-in-iframe.mdx | 4 ++-- migration-services/go-live-checklist.mdx | 2 +- mint-instructions/publish/assistant.mdx | 2 +- mint-instructions/publish/domain.mdx | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/assistant/widget.mdx b/assistant/widget.mdx index 28e5375a0a..f9117b6bde 100644 --- a/assistant/widget.mdx +++ b/assistant/widget.mdx @@ -24,9 +24,9 @@ The only required browser option is your public widget ID. Set embed-specific st ## Enable the widget - You can no longer configure the widget in the dashboard. If you already use the widget, it keeps working on your authorized sites. + You can no longer enable or configure the widget in the dashboard. If you already use the widget, it keeps working on your authorized sites. - Email [support@mintlify.com](mailto:support@mintlify.com) if you need help setting up the widget on a new site. + To add an AI assistant to a new site or app, build your own with the assistant API. Follow the [Build an in-app assistant](/guides/assistant-embed) tutorial to create a chat widget that answers questions from your documentation. ## Install and configure diff --git a/help-center/embed-docs-site-in-iframe.mdx b/help-center/embed-docs-site-in-iframe.mdx index 145928e787..2c7a54bbe7 100644 --- a/help-center/embed-docs-site-in-iframe.mdx +++ b/help-center/embed-docs-site-in-iframe.mdx @@ -28,6 +28,6 @@ Include staging or local development origins in your request if you need to test If you serve your docs through your own reverse proxy that overwrites the `Content-Security-Policy` header, set `frame-ancestors` in your proxy's policy instead. See [CSP configuration](/deploy/csp-configuration). -## Alternative: embed the assistant widget +## Alternative: build an in-app assistant -If you want users to get answers from your documentation inside your app without loading the full site, embed the assistant widget instead. The widget loads from a hosted script, so it does not depend on your docs site's `frame-ancestors` policy. You manage the origins allowed to load the widget in your dashboard. The widget requires a Pro or Enterprise plan. See [Embed the AI assistant widget](/assistant/widget). +If you want users to get answers from your documentation inside your app without loading the full site, build your own assistant with the assistant API instead. It does not load your docs site, so it does not depend on your docs site's `frame-ancestors` policy. See [Build an in-app assistant](/guides/assistant-embed). diff --git a/migration-services/go-live-checklist.mdx b/migration-services/go-live-checklist.mdx index eb67ae7bbf..c2822ddcf1 100644 --- a/migration-services/go-live-checklist.mdx +++ b/migration-services/go-live-checklist.mdx @@ -37,7 +37,7 @@ Use this checklist to set up configurations and validate settings before going l - Configure your [support and sales deflection emails](/assistant/configure#set-deflection-emails). - Configure your [search domains](/assistant/configure#search-domains). - Customize the [assistant's response patterns](/assistant/customize) and [add assistant skills](/assistant/skills). -- **Embed the assistant widget.** Enable the [assistant widget](/assistant/widget) to add the assistant to your product dashboard, marketing site, or support portal. +- **Build an in-app assistant.** Use the assistant API to [build your own assistant](/guides/assistant-embed) for your product dashboard, marketing site, or support portal. - **Enable add-ons.** Go to the [Site](https://app.mintlify.com/settings/project/site) page in your dashboard. Enable relevant add-ons such as agent feedback, [CI checks](/deploy/ci), related topics, and more. - **Set up the Slack agent.** This lets you make changes to your content directly in Slack. See [Connect your Slack workspace](/agent/slack#connect-your-slack-workspace). - **Set up automations.** See [how to enable an automation](/automations/manage#enable-an-automation). diff --git a/mint-instructions/publish/assistant.mdx b/mint-instructions/publish/assistant.mdx index c8fcf05ef8..6207ff5c10 100644 --- a/mint-instructions/publish/assistant.mdx +++ b/mint-instructions/publish/assistant.mdx @@ -81,7 +81,7 @@ description: Step-by-step guide for upgrading from SDK v2 to v3, including break } ``` -Widget. The widget is no longer configurable in the dashboard (an enabled widget's Widget settings entry only links to the docs). To enable the widget for a site, get a widget ID, or change authorized sites or availability, the user emails support@mintlify.com. Existing widgets keep working on their authorized sites. Install code comes from the playground on https://www.mintlify.com/docs/assistant/widget (do not invent the loader URL). Then initialize; `id` is the only required option: +Widget. The widget is no longer configurable in the dashboard (an enabled widget's Widget settings entry only links to the docs). New widgets are not available: to add an assistant to a new site or app, the user builds their own with the assistant API, following https://www.mintlify.com/docs/guides/assistant-embed. Existing widgets keep working on their authorized sites; for changes to an existing widget, the user emails support@mintlify.com. Install code comes from the playground on https://www.mintlify.com/docs/assistant/widget (do not invent the loader URL). Then initialize; `id` is the only required option: ```js await window.MintlifyAssistant.init({ id: "YOUR_WIDGET_ID", diff --git a/mint-instructions/publish/domain.mdx b/mint-instructions/publish/domain.mdx index 233824bd6d..5fc98b6db3 100644 --- a/mint-instructions/publish/domain.mdx +++ b/mint-instructions/publish/domain.mdx @@ -45,7 +45,7 @@ Use this to host docs on the user's domain or a subpath of their site, or to fix - Only add the Mintlify CNAME with `--basePath` if the domain hosts nothing else. - Do not rewrite only `/docs/llms.txt` to root; forward the full base path route. - CSP: the default CSP allows any HTTPS origin; it blocks plain HTTP resources, `blob:`/`data:` scripts, ``/``, cross-origin workers. A proxy that overwrites CSP must allow the required domains (`*.mintlify.site`, `*.mintlify.com`, `mintcdn.com`, `*.mintcdn.com`, hCaptcha, two CloudFront hosts and more): copy the policy from the CSP page. -- Iframes: default `frame-ancestors 'self' https://dashboard.mintlify.com https://app.mintlify.com` blocks other sites. It is not configurable in `docs.json`. Email support@mintlify.com with subdomain, docs domain, every origin (wildcard subdomains allowed) and use case. Own proxy overwriting CSP: set `frame-ancestors` there. Alternative: assistant widget (Pro or Enterprise). +- Iframes: default `frame-ancestors 'self' https://dashboard.mintlify.com https://app.mintlify.com` blocks other sites. It is not configurable in `docs.json`. Email support@mintlify.com with subdomain, docs domain, every origin (wildcard subdomains allowed) and use case. Own proxy overwriting CSP: set `frame-ancestors` there. Alternative: build an in-app assistant with the assistant API (https://www.mintlify.com/docs/guides/assistant-embed). - Default address stays indexed: the default Mintlify address remains reachable and crawlable after adding a domain. Support can make it return 404, only if the CNAME points to `cname.mintlify.builders` (not with a reverse proxy or a CNAME to the default address). While disabled, new domains cannot be added from the dashboard. Also set the canonical and submit `https:///sitemap.xml` in Search Console. - `Domain is already in use by another deployment in your organization` or `Domain is already claimed by another organization`: one project holds a domain at a time. Remove it (trash icon) on the holding project's Custom domain setup page, then re-add. No access to that org: email support with proof of DNS control. From 8620c3e87da09441e3b03894689bfe5d408edda9 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 9 Nov 2026 18:12:07 +0000 Subject: [PATCH 2/2] docs: suggest pointing a coding agent at the assistant API for a widget --- assistant/widget.mdx | 4 +++- mint-instructions/publish/assistant.mdx | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/assistant/widget.mdx b/assistant/widget.mdx index f9117b6bde..8eaed54e0a 100644 --- a/assistant/widget.mdx +++ b/assistant/widget.mdx @@ -26,7 +26,9 @@ The only required browser option is your public widget ID. Set embed-specific st You can no longer enable or configure the widget in the dashboard. If you already use the widget, it keeps working on your authorized sites. - To add an AI assistant to a new site or app, build your own with the assistant API. Follow the [Build an in-app assistant](/guides/assistant-embed) tutorial to create a chat widget that answers questions from your documentation. + To add an AI assistant to a new site or app, build your own with the [assistant API](/api/assistant/create-assistant-message-v2). Follow the [Build an in-app assistant](/guides/assistant-embed) tutorial to create a chat widget that answers questions from your documentation. + + You can also point a coding agent to the [create assistant message](/api/assistant/create-assistant-message-v2) API reference and ask it to build a widget for your app. ## Install and configure diff --git a/mint-instructions/publish/assistant.mdx b/mint-instructions/publish/assistant.mdx index 6207ff5c10..57e372f522 100644 --- a/mint-instructions/publish/assistant.mdx +++ b/mint-instructions/publish/assistant.mdx @@ -81,7 +81,7 @@ description: Step-by-step guide for upgrading from SDK v2 to v3, including break } ``` -Widget. The widget is no longer configurable in the dashboard (an enabled widget's Widget settings entry only links to the docs). New widgets are not available: to add an assistant to a new site or app, the user builds their own with the assistant API, following https://www.mintlify.com/docs/guides/assistant-embed. Existing widgets keep working on their authorized sites; for changes to an existing widget, the user emails support@mintlify.com. Install code comes from the playground on https://www.mintlify.com/docs/assistant/widget (do not invent the loader URL). Then initialize; `id` is the only required option: +Widget. The widget is no longer configurable in the dashboard (an enabled widget's Widget settings entry only links to the docs). New widgets are not available: to add an assistant to a new site or app, the user builds their own with the assistant API, following https://www.mintlify.com/docs/guides/assistant-embed, or points a coding agent at https://www.mintlify.com/docs/api/assistant/create-assistant-message-v2 to build one. Existing widgets keep working on their authorized sites; for changes to an existing widget, the user emails support@mintlify.com. Install code comes from the playground on https://www.mintlify.com/docs/assistant/widget (do not invent the loader URL). Then initialize; `id` is the only required option: ```js await window.MintlifyAssistant.init({ id: "YOUR_WIDGET_ID",