Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

@ethanpalm ethanpalm commented Dec 11, 2025

Documentation changes

Part of https://linear.app/mintlify/issue/DOC-214/qanda-bot-launches-slack-discord-telegram


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Adds Discord bot docs and links the page in the Optimize section of the navigation.

  • Documentation
    • New page ai/discord.mdx describing the Discord bot, setup (connect via dashboard), #ask-ai channel behavior, management, and plan availability; includes illustrative images.
  • Navigation
    • Adds ai/discord to the Optimize section in docs.json (English navigation).

Written by Cursor Bugbot for commit a318b7a. This will update automatically on new commits. Configure here.

ai/discord.mdx Outdated
1. Authorize the bot to access your server.
1. Add the bot to any channels you want it to be available in.

## Configure the Discord bot
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

overall im not a huge fan of docs that kinda walk u thru the UI - imo we failed in the UI when that happens. A couple of the sections here are like that.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feels like a fair assumption that if someone is setting up a Mintlify Discord bot, they're already familiar with Discord and not learning to use it. Will revise

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ill always assume that people will skim/not read everything too. i think adding a picture of this will be good; however, i want to iterate on the design before we include it lol

Image

ai/discord.mdx Outdated
Discord integrations are available on [Pro and Custom plans](https://mintlify.com/pricing?ref=discord) with access to the Mintlify assistant.
</Info>

The Discord bot supports your community with real-time answers from your documentation. The bot is trained on your documentation, so it is always up-to-date and answers questions by directly citing your docs.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice


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
Copy link

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 modal placeholder 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.

Fix in Cursor Fix in Web

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants