-
Notifications
You must be signed in to change notification settings - Fork 214
Discord bot #2214
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ethanpalm
wants to merge
15
commits into
main
Choose a base branch
from
discord-bot
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+44
−0
Open
Discord bot #2214
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
6eb22cc
create discord file
ethanpalm 7d5af4c
add front matter
ethanpalm f22e7d8
add content
ethanpalm f5b1f44
add images
ethanpalm d3cea3a
remove todo and passive voice
ethanpalm b11907e
adding bot and #ask-ai
ethanpalm c65d3cd
add remove steps
ethanpalm d709774
update permission note
ethanpalm 53c1d38
update intro and key words
ethanpalm 045a398
remove unneeded step
ethanpalm 526621c
focus on outcomes, not steps
ethanpalm 2226d37
remove unused images
ethanpalm a696650
reorder sections
ethanpalm 0c661e5
💅
ethanpalm a318b7a
update intro
ethanpalm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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"] | ||
| --- | ||
|
|
||
| <Info> | ||
| Discord integrations are available on [Pro and Custom plans](https://mintlify.com/pricing?ref=discord) with access to the assistant. | ||
| </Info> | ||
|
|
||
| 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 | ||
|
|
||
| <Note> | ||
| You must have the "Manage Server" permission in Discord to add the bot. | ||
| </Note> | ||
|
|
||
| 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. | ||
| <Frame> | ||
| <img src="/images/assistant/discord-connect-light.png" alt="The connect button in light mode." className="block dark:hidden" /> | ||
| <img src="/images/assistant/discord-connect-dark.png" alt="The connect button in dark mode." className="hidden dark:block" /> | ||
| </Frame> | ||
| 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 | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -162,6 +162,7 @@ | |
| "insights/feedback" | ||
| ] | ||
| }, | ||
| "ai/discord", | ||
| "ai/llmstxt", | ||
| "ai/model-context-protocol", | ||
| "optimize/seo", | ||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: TODO comment left in production documentation
A
TODO: add image of configuration modalplaceholder was left in the documentation. This appears to be an incomplete work note that will be visible to users in the published documentation. The "Manage the Discord bot" section references adding an image that hasn't been included.