Skip to content

Commit 7bb754a

Browse files
authored
Discord bot (#2214)
* create discord file * add front matter * add content * add images * remove todo and passive voice * adding bot and #ask-ai * add remove steps * update permission note * update intro and key words * remove unneeded step * focus on outcomes, not steps * remove unused images * reorder sections * 💅 * update intro * add image of the discord config panel * fix image path
1 parent d479856 commit 7bb754a

File tree

6 files changed

+47
-0
lines changed

6 files changed

+47
-0
lines changed

ai/discord.mdx

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: "Discord bot"
3+
description: "Add a bot to your Discord server that answers questions based on your documentation."
4+
keywords: ["Discord", "bot", "Q&A", "customer support"]
5+
---
6+
7+
<Info>
8+
Discord integrations are available on [Pro and Custom plans](https://mintlify.com/pricing?ref=discord) with access to the assistant.
9+
</Info>
10+
11+
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.
12+
13+
The Discord bot responds to `@` mentions and to every message in channels named `#ask-ai`.
14+
15+
Each message sent by the Discord bot counts toward your assistant message usage.
16+
17+
## Add the Discord bot to your server
18+
19+
<Note>
20+
You must have the "Manage Server" permission in Discord to add the bot.
21+
</Note>
22+
23+
1. Navigate to the [Integrations](https://dashboard.mintlify.com/products/assistant/settings/integrations) tab of the **Assistant Configurations** page in your dashboard.
24+
1. In the Discord card, click **Connect**. This opens Discord.
25+
<Frame>
26+
<img src="/images/assistant/discord-connect-light.png" alt="The connect button in light mode." className="block dark:hidden" />
27+
<img src="/images/assistant/discord-connect-dark.png" alt="The connect button in dark mode." className="hidden dark:block" />
28+
</Frame>
29+
1. In Discord, select the server you want to add the bot to.
30+
1. Authorize the bot to access your server.
31+
1. Mention the bot to add it to a channel. The bot's default name is `@Mintlify Bot`.
32+
33+
## Create an `#ask-ai` channel
34+
35+
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.
36+
37+
## Manage the Discord bot
38+
39+
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.
40+
41+
Customize the bot's avatar and name to match your brand then let your community know they can mention it to get answers.
42+
43+
<Frame>
44+
<img src="/images/assistant/discord-configure-light.png" alt="The Discord configuration panel in light mode." className="block dark:hidden" />
45+
<img src="/images/assistant/discord-configure-dark.png" alt="The Discord configuration panel in dark mode." className="hidden dark:block" />
46+
</Frame>

docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,7 @@
162162
"insights/feedback"
163163
]
164164
},
165+
"ai/discord",
165166
"ai/slack-app",
166167
"ai/llmstxt",
167168
"ai/model-context-protocol",
95.4 KB
Loading
93.9 KB
Loading
30.2 KB
Loading
29.2 KB
Loading

0 commit comments

Comments
 (0)