diff --git a/ai/discord.mdx b/ai/discord.mdx new file mode 100644 index 000000000..b83aeb87d --- /dev/null +++ b/ai/discord.mdx @@ -0,0 +1,43 @@ +--- +title: "Discord bot" +description: "Add a bot to your Discord server that answers questions based on your documentation." +keywords: ["Discord", "bot", "Q&A", "customer support"] +--- + + + Discord integrations are available on [Pro and Custom plans](https://mintlify.com/pricing?ref=discord) with access to the assistant. + + +The Discord bot supports your community with real-time answers from your documentation. The bot uses the Mintlify assistant to search your docs and provide accurate, cited responses, so it is always up-to-date. + +The Discord bot responds to `@` mentions and to every message in channels named `#ask-ai`. + +Each message sent by the Discord bot counts toward your assistant message usage. + +## Add the Discord bot to your server + + + You must have the "Manage Server" permission in Discord to add the bot. + + +1. Navigate to the [Integrations](https://dashboard.mintlify.com/products/assistant/settings/integrations) tab of the **Assistant Configurations** page in your dashboard. +1. In the Discord card, click **Connect**. This opens Discord. + + The connect button in light mode. + The connect button in dark mode. + +1. In Discord, select the server you want to add the bot to. +1. Authorize the bot to access your server. +1. Mention the bot to add it to a channel. The bot's default name is `@Mintlify Bot`. + +## Create an `#ask-ai` channel + +To help your community quickly get answers to their questions, create a channel named `#ask-ai` and add the bot to it. The bot will respond to every message in that channel. See [Starting Your First Discord Server](https://discord.com/blog/starting-your-first-discord-server) on the Discord blog for more information on creating a channel. + +## Manage the Discord bot + +After you add the bot to your server, you can manage or remove the integration from the [Integrations](https://dashboard.mintlify.com/products/assistant/settings/integrations) tab. + +Customize the bot's avatar and name to match your brand then let your community know they can mention it to get answers. + +TODO: add image of configuration modal diff --git a/docs.json b/docs.json index 14c75d6fd..60fdcf95c 100644 --- a/docs.json +++ b/docs.json @@ -162,6 +162,7 @@ "insights/feedback" ] }, + "ai/discord", "ai/llmstxt", "ai/model-context-protocol", "optimize/seo", diff --git a/images/assistant/discord-connect-dark.png b/images/assistant/discord-connect-dark.png new file mode 100644 index 000000000..d00839510 Binary files /dev/null and b/images/assistant/discord-connect-dark.png differ diff --git a/images/assistant/discord-connect-light.png b/images/assistant/discord-connect-light.png new file mode 100644 index 000000000..78f516501 Binary files /dev/null and b/images/assistant/discord-connect-light.png differ