From aed0acd12c08982e9647a9f0fcb2516f9f96e2ea Mon Sep 17 00:00:00 2001 From: Han Wang <44352119+handotdev@users.noreply.github.com> Date: Thu, 11 Dec 2025 17:15:19 -0800 Subject: [PATCH 1/4] Update ai/assistant-integrations.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- ai/assistant-integrations.mdx | 160 ++++++++++++++++++++++++++++++++++ 1 file changed, 160 insertions(+) create mode 100644 ai/assistant-integrations.mdx diff --git a/ai/assistant-integrations.mdx b/ai/assistant-integrations.mdx new file mode 100644 index 000000000..797e7176c --- /dev/null +++ b/ai/assistant-integrations.mdx @@ -0,0 +1,160 @@ +--- +title: "Assistant integrations" +description: "Connect Discord and Slack to let the Mintlify Assistant answer questions in your community channels." +keywords: ["Discord", "Slack", "integrations", "assistant", "chat"] +--- + +Connect your Discord servers and Slack workspaces to the Mintlify Assistant to provide AI-powered documentation support directly in your community channels. The assistant answers questions using your documentation, helping users get instant answers without leaving their preferred communication platform. + +## About assistant integrations + +Assistant integrations extend the Mintlify Assistant to Discord and Slack channels. When connected, the assistant: + +* **Answers questions** about your documentation in Discord and Slack channels. +* **Cites sources** with links back to your documentation. +* **Generates code examples** to help users implement solutions. + +Each message sent through Discord or Slack integrations counts toward your plan's message allowance, just like messages sent through your documentation site. + +## Access integrations + +Navigate to the integrations page in your dashboard to connect Discord and Slack: + +1. Go to your [dashboard](https://dashboard.mintlify.com). +2. Select your documentation site. +3. Click **Assistant** in the sidebar. +4. Click **Settings**. +5. Click the **Integrations** tab. + + + The Integrations tab in the Assistant settings page. + The Integrations tab in the Assistant settings page. + + +## Connect Discord + +Connect your Discord server to enable the Mintlify Assistant in your Discord channels. + +### Prerequisites + +You need administrator permissions on the Discord server you want to connect. + +### Connect your server + +1. Navigate to the [Integrations tab](#access-integrations) in your assistant settings. +2. Find **Discord** in the list of available integrations. +3. Click **Connect**. +4. Sign in to Discord if prompted. +5. Select the server you want to add the assistant to. +6. Review the permissions and click **Authorize**. + + + The Discord integration card with a Connect button. + The Discord integration card with a Connect button. + + +After authorization, you're redirected back to your dashboard. The Discord integration shows a **Connected** status badge. + +### Use the assistant in Discord + +Once connected, the Mintlify Assistant bot appears in your Discord server. Users can interact with the assistant by: + +* **Mentioning the bot** in any channel where it has permissions: `@Mintlify Assistant How do I set up authentication?` +* **Direct messaging** the bot for private conversations. + +The assistant responds with answers from your documentation, including source citations and code examples when relevant. + +### Manage your connection + +After connecting Discord, you can configure which channels the assistant can access: + +1. Navigate to the [Integrations tab](#access-integrations) in your assistant settings. +2. Find **Discord** in the connected apps section. +3. Click **Configure**. + + + The Discord integration card showing Connected status with a Configure button. + The Discord integration card showing Connected status with a Configure button. + + +## Connect Slack + +Connect your Slack workspace to enable the Mintlify Assistant in your Slack channels. + +### Prerequisites + +You need permission to install apps in your Slack workspace. + +### Connect your workspace + +1. Navigate to the [Integrations tab](#access-integrations) in your assistant settings. +2. Find **Slack** in the list of available integrations. +3. Click **Connect**. +4. Review the permissions and click **Allow**. + + + The Slack integration card with a Connect button. + The Slack integration card with a Connect button. + + +After authorization, you're redirected back to your dashboard. The Slack integration shows a **Connected** status badge. + +### Use the assistant in Slack + +Once connected, the Mintlify Assistant app appears in your Slack workspace. Users can interact with the assistant by: + +* **Mentioning the app** in any channel where it's added: `@Mintlify Assistant How do I deploy my docs?` +* **Direct messaging** the app for private conversations. +* **Adding the app to channels** by typing `/invite @Mintlify Assistant` in the channel. + +The assistant responds with answers from your documentation, including source citations and code examples when relevant. + +### Manage your connection + +After connecting Slack, you can configure assistant behavior: + +1. Navigate to the [Integrations tab](#access-integrations) in your assistant settings. +2. Find **Slack** in the connected apps section. +3. Click **Configure**. + + + The Slack integration card showing Connected status with a Configure button. + The Slack integration card showing Connected status with a Configure button. + + +## Disconnect integrations + +To disconnect Discord or Slack: + +1. Navigate to the [Integrations tab](#access-integrations) in your assistant settings. +2. Find the integration in the connected apps section. +3. Click **Configure**. +4. Click **Disconnect**. + +After disconnecting, the assistant stops responding to messages in that platform. You can reconnect at any time by following the connection steps again. + +## Troubleshooting + + + Verify that: + - The bot has permission to read and send messages in the channel. + - You're mentioning the bot correctly with `@Mintlify Assistant`. + - Your assistant is enabled in your [dashboard settings](https://dashboard.mintlify.com/products/assistant/settings). + - You haven't exceeded your message allowance or spend limit. + + + + Verify that: + - The app is added to the channel where you're trying to use it. + - You're mentioning the app correctly with `@Mintlify Assistant`. + - Your assistant is enabled in your [dashboard settings](https://dashboard.mintlify.com/products/assistant/settings). + - You haven't exceeded your message allowance or spend limit. + + + + Ensure you have administrator permissions on the Discord server. If you're not an administrator, ask a server administrator to connect the integration. + + + + Ensure you have permission to install apps in your Slack workspace. If you don't have permission, ask a workspace administrator to install the Mintlify Assistant app. + From c8b0f7fa81ff2f59af71c49c028e736943a7923e Mon Sep 17 00:00:00 2001 From: Han Wang <44352119+handotdev@users.noreply.github.com> Date: Thu, 11 Dec 2025 17:15:34 -0800 Subject: [PATCH 2/4] Update docs.json Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- docs.json | 1 + 1 file changed, 1 insertion(+) diff --git a/docs.json b/docs.json index 2f4d0288a..1b31fc4fa 100644 --- a/docs.json +++ b/docs.json @@ -154,6 +154,7 @@ "icon": "wrench", "pages": [ "ai/assistant", + "ai/assistant-integrations", "ai/contextual-menu", { "group": "Insights", From 88ec331d7d7846e10aa293dd299b50ef6f76e7a8 Mon Sep 17 00:00:00 2001 From: Han Wang <44352119+handotdev@users.noreply.github.com> Date: Thu, 11 Dec 2025 17:19:31 -0800 Subject: [PATCH 3/4] Delete ai/assistant-integrations.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- ai/assistant-integrations.mdx | 160 ---------------------------------- 1 file changed, 160 deletions(-) delete mode 100644 ai/assistant-integrations.mdx diff --git a/ai/assistant-integrations.mdx b/ai/assistant-integrations.mdx deleted file mode 100644 index 797e7176c..000000000 --- a/ai/assistant-integrations.mdx +++ /dev/null @@ -1,160 +0,0 @@ ---- -title: "Assistant integrations" -description: "Connect Discord and Slack to let the Mintlify Assistant answer questions in your community channels." -keywords: ["Discord", "Slack", "integrations", "assistant", "chat"] ---- - -Connect your Discord servers and Slack workspaces to the Mintlify Assistant to provide AI-powered documentation support directly in your community channels. The assistant answers questions using your documentation, helping users get instant answers without leaving their preferred communication platform. - -## About assistant integrations - -Assistant integrations extend the Mintlify Assistant to Discord and Slack channels. When connected, the assistant: - -* **Answers questions** about your documentation in Discord and Slack channels. -* **Cites sources** with links back to your documentation. -* **Generates code examples** to help users implement solutions. - -Each message sent through Discord or Slack integrations counts toward your plan's message allowance, just like messages sent through your documentation site. - -## Access integrations - -Navigate to the integrations page in your dashboard to connect Discord and Slack: - -1. Go to your [dashboard](https://dashboard.mintlify.com). -2. Select your documentation site. -3. Click **Assistant** in the sidebar. -4. Click **Settings**. -5. Click the **Integrations** tab. - - - The Integrations tab in the Assistant settings page. - The Integrations tab in the Assistant settings page. - - -## Connect Discord - -Connect your Discord server to enable the Mintlify Assistant in your Discord channels. - -### Prerequisites - -You need administrator permissions on the Discord server you want to connect. - -### Connect your server - -1. Navigate to the [Integrations tab](#access-integrations) in your assistant settings. -2. Find **Discord** in the list of available integrations. -3. Click **Connect**. -4. Sign in to Discord if prompted. -5. Select the server you want to add the assistant to. -6. Review the permissions and click **Authorize**. - - - The Discord integration card with a Connect button. - The Discord integration card with a Connect button. - - -After authorization, you're redirected back to your dashboard. The Discord integration shows a **Connected** status badge. - -### Use the assistant in Discord - -Once connected, the Mintlify Assistant bot appears in your Discord server. Users can interact with the assistant by: - -* **Mentioning the bot** in any channel where it has permissions: `@Mintlify Assistant How do I set up authentication?` -* **Direct messaging** the bot for private conversations. - -The assistant responds with answers from your documentation, including source citations and code examples when relevant. - -### Manage your connection - -After connecting Discord, you can configure which channels the assistant can access: - -1. Navigate to the [Integrations tab](#access-integrations) in your assistant settings. -2. Find **Discord** in the connected apps section. -3. Click **Configure**. - - - The Discord integration card showing Connected status with a Configure button. - The Discord integration card showing Connected status with a Configure button. - - -## Connect Slack - -Connect your Slack workspace to enable the Mintlify Assistant in your Slack channels. - -### Prerequisites - -You need permission to install apps in your Slack workspace. - -### Connect your workspace - -1. Navigate to the [Integrations tab](#access-integrations) in your assistant settings. -2. Find **Slack** in the list of available integrations. -3. Click **Connect**. -4. Review the permissions and click **Allow**. - - - The Slack integration card with a Connect button. - The Slack integration card with a Connect button. - - -After authorization, you're redirected back to your dashboard. The Slack integration shows a **Connected** status badge. - -### Use the assistant in Slack - -Once connected, the Mintlify Assistant app appears in your Slack workspace. Users can interact with the assistant by: - -* **Mentioning the app** in any channel where it's added: `@Mintlify Assistant How do I deploy my docs?` -* **Direct messaging** the app for private conversations. -* **Adding the app to channels** by typing `/invite @Mintlify Assistant` in the channel. - -The assistant responds with answers from your documentation, including source citations and code examples when relevant. - -### Manage your connection - -After connecting Slack, you can configure assistant behavior: - -1. Navigate to the [Integrations tab](#access-integrations) in your assistant settings. -2. Find **Slack** in the connected apps section. -3. Click **Configure**. - - - The Slack integration card showing Connected status with a Configure button. - The Slack integration card showing Connected status with a Configure button. - - -## Disconnect integrations - -To disconnect Discord or Slack: - -1. Navigate to the [Integrations tab](#access-integrations) in your assistant settings. -2. Find the integration in the connected apps section. -3. Click **Configure**. -4. Click **Disconnect**. - -After disconnecting, the assistant stops responding to messages in that platform. You can reconnect at any time by following the connection steps again. - -## Troubleshooting - - - Verify that: - - The bot has permission to read and send messages in the channel. - - You're mentioning the bot correctly with `@Mintlify Assistant`. - - Your assistant is enabled in your [dashboard settings](https://dashboard.mintlify.com/products/assistant/settings). - - You haven't exceeded your message allowance or spend limit. - - - - Verify that: - - The app is added to the channel where you're trying to use it. - - You're mentioning the app correctly with `@Mintlify Assistant`. - - Your assistant is enabled in your [dashboard settings](https://dashboard.mintlify.com/products/assistant/settings). - - You haven't exceeded your message allowance or spend limit. - - - - Ensure you have administrator permissions on the Discord server. If you're not an administrator, ask a server administrator to connect the integration. - - - - Ensure you have permission to install apps in your Slack workspace. If you don't have permission, ask a workspace administrator to install the Mintlify Assistant app. - From c0aee9645b6ed5ba1eb09f635020568fc53564a9 Mon Sep 17 00:00:00 2001 From: Han Wang <44352119+handotdev@users.noreply.github.com> Date: Thu, 11 Dec 2025 17:19:45 -0800 Subject: [PATCH 4/4] Update docs.json Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- docs.json | 1 - 1 file changed, 1 deletion(-) diff --git a/docs.json b/docs.json index 1b31fc4fa..2f4d0288a 100644 --- a/docs.json +++ b/docs.json @@ -154,7 +154,6 @@ "icon": "wrench", "pages": [ "ai/assistant", - "ai/assistant-integrations", "ai/contextual-menu", { "group": "Insights",