Skip to content

Remove Slack/Discord bot setup docs #5016

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.

Sign up for GitHub

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
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Remove Slack/Discord bot setup docs #5016

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions ai/assistant.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,10 +167,6 @@ If you want to disallow overages, disable them in the **Billing Controls** secti

In the Billing Controls section, set usage alerts to receive an email when you reach a certain percentage of your message allowance.

## Connect apps

In the connect apps section, add the assistant to your [Discord](/ai/discord) server and [Slack](/ai/slack-bot) workspace to allow users to get answers from your documentation on those platforms.

## Assistant insights

Use assistant insights to understand how users interact with your documentation and identify improvement opportunities.
Expand Down Expand Up @@ -202,8 +198,6 @@ Structure your documentation to help the assistant provide accurate, relevant an

Users have multiple ways to start a conversation with the assistant. Each method opens a chat panel on the right side of your docs. Users can ask any question and the assistant searches your documentation for an answer. If the assistant cannot retrieve relevant information, the assistant responds that it cannot answer the question.

Add the assistant as a bot to your [Slack workspace](/ai/slack-bot) or [Discord server](/ai/discord) so that your community can ask questions without leaving their preferred platform.

### UI placement

The assistant appears in two locations: as a button next to the search bar and as a bar at the bottom of the page.
Expand Down
35 changes: 3 additions & 32 deletions ai/discord.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,47 +4,18 @@ description: "Add a bot to your Discord server that answers questions based on y
keywords: ["Discord", "bot", "Q&A", "customer support"]
---

<Info>
Discord integrations are available on [Pro and Enterprise plans](https://mintlify.com/pricing?ref=discord) with access to the assistant.
</Info>
<Warning>
New Discord bot installations are no longer available through the dashboard. Existing Discord bot integrations continue to work.
</Warning>

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 only works in public channels. It replies to `@` mentions or to all messages in a specific channel.

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 [Assistant](https://dashboard.mintlify.com/products/assistant) page in your dashboard.
1. In the Discord card, click **Configure**. This opens Discord.
<Frame>
<img src="/images/assistant/connected-apps-light.png" alt="The connected apps section of the assistant page." className="block dark:hidden" />
<img src="/images/assistant/connected-apps-dark.png" alt="The connected apps section of the assistant page." 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, the bot can reply to every message in a channel that you choose. By default, the bot replies to every message in channels named `#ask-ai`. Create an `#ask-ai` channel and let your community know that the bot replies to messages in that channel.

If you want the bot to reply to messages in a different channel, select a channel in the Discord bot [configuration menu](https://dashboard.mintlify.com/products/assistant/settings/integrations).

<Frame>
<img src="/images/assistant/discord-configure-light.png" alt="The Discord configuration panel in light mode." className="block dark:hidden" />
<img src="/images/assistant/discord-configure-dark.png" alt="The Discord configuration panel in dark mode." className="hidden dark:block" />
</Frame>

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 Discord bot to your server, you can manage or remove the bot from the [Integrations](https://dashboard.mintlify.com/products/assistant/settings/integrations) tab in your dashboard.

In the Discord bot configuration menu, customize the bot by changing its avatar or name, and choose which channel it automatically replies to all messages in.
36 changes: 3 additions & 33 deletions ai/slack-bot.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ description: "Add a bot to your Slack workspace that answers questions based on
keywords: ["bot", "workspace", "Q&A", "Slack", "app"]
---

<Info>
The Slack app is available for [Pro and Custom plans](https://mintlify.com/pricing?ref=slack-app) with access to the assistant.
</Info>
<Warning>
New Slack bot installations are no longer available through the dashboard. Existing Slack bot integrations continue to work.
</Warning>

The Slack app adds a bot to your workspace that supports your community with real-time answers. The bot uses the Mintlify assistant to search your docs and provide accurate, cited responses, so it is always up-to-date.

Expand All @@ -16,36 +16,6 @@ The bot responds to `@` mentions or to all messages in a specific channel that y

Each message sent by the bot counts toward your assistant message usage.

## Set up the Slack app

<Note>
You can only install the Slack app once per workspace. If you have multiple Mintlify deployments, you can only connect one deployment at a time to a workspace. You must disconnect the app from one deployment before connecting it to another.
</Note>

If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the Mintlify Slack app before you add it.

1. Navigate to the [Assistant](https://dashboard.mintlify.com/products/assistant) page in your dashboard.
1. In the Slack card, click **Configure**. This opens Slack.
<Frame>
<img src="/images/assistant/connected-apps-light.png" alt="The connected apps section of the assistant page." className="block dark:hidden" />
<img src="/images/assistant/connected-apps-dark.png" alt="The connected apps section of the assistant page." className="hidden dark:block" />
</Frame>
1. Follow the Slack prompts to add the app to your workspace.
1. Mention the bot to add it to a channel. The bot's default name is `@mintlify-assistant`.

## Create an `#ask-ai` channel

To help your users quickly get answers to their questions, the bot can reply to every message in a channel that you choose. By default, the bot replies to every message in channels named `#ask-ai`. Create an `#ask-ai` channel and let your users know that the bot replies to messages in that channel. See [Create a channel](https://slack.com/help/articles/201402297-Create-a-channel) in the Slack Help Center for more information.

If you want the bot to reply to messages in a different channel, select a channel in the Slack bot [configuration menu](https://dashboard.mintlify.com/products/assistant/settings/integrations).

<Frame>
<img src="/images/assistant/slack-configure-light.png" alt="The Slack configuration panel in light mode." className="block dark:hidden" />
<img src="/images/assistant/slack-configure-dark.png" alt="The Slack configuration panel in dark mode." className="hidden dark:block" />
</Frame>

## Manage the Slack app

After you add the app to your workspace, you can manage or remove the app from the [Integrations](https://dashboard.mintlify.com/products/assistant/settings/integrations) tab.

In the Slack bot configuration menu, customize the bot by changing its avatar or name, and choose which channel it automatically replies to all messages in.
8 changes: 0 additions & 8 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,8 +198,6 @@
"icon": "wrench",
"pages": [
"ai/assistant",
"ai/discord",
"ai/slack-bot",
"ai/contextual-menu",
"optimize/analytics",
"optimize/feedback",
Expand Down Expand Up @@ -571,8 +569,6 @@
"icon": "wrench",
"pages": [
"fr/ai/assistant",
"fr/ai/discord",
"fr/ai/slack-bot",
"fr/ai/contextual-menu",
"fr/optimize/analytics",
"fr/optimize/feedback",
Expand Down Expand Up @@ -943,8 +939,6 @@
"icon": "wrench",
"pages": [
"es/ai/assistant",
"es/ai/discord",
"es/ai/slack-bot",
"es/ai/contextual-menu",
"es/optimize/analytics",
"es/optimize/feedback",
Expand Down Expand Up @@ -1315,8 +1309,6 @@
"icon": "wrench",
"pages": [
"zh/ai/assistant",
"zh/ai/discord",
"zh/ai/slack-bot",
"zh/ai/contextual-menu",
"zh/optimize/analytics",
"zh/optimize/feedback",
Expand Down
8 changes: 0 additions & 8 deletions es/ai/assistant.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,12 +199,6 @@ Si no quieres permitir excedentes, desactívalos en la sección **Billing Contro

En la sección Billing Controls, configura alertas de uso para recibir un correo electrónico cuando alcances cierto porcentaje de tu cupo de mensajes.

<div id="connect-apps">
## Conectar aplicaciones
</div>

En la sección Conectar aplicaciones, agrega el assistant a tu servidor de [Discord](/es/ai/discord) y al espacio de trabajo de [Slack](/es/ai/slack-bot) para que los usuarios puedan obtener respuestas de tu documentación en esas plataformas.

<div id="assistant-insights">
## Información del assistant
</div>
Expand Down Expand Up @@ -242,8 +236,6 @@ Estructura tu documentación para ayudar al assistant a ofrecer respuestas preci

Los usuarios tienen varias formas de iniciar una conversación con el assistant. Cada método abre un panel de chat en el lado derecho de tu documentación. Los usuarios pueden hacer cualquier pregunta y el assistant busca una respuesta en tu documentación. Si el assistant no puede recuperar información relevante, el assistant indica que no puede responder a la pregunta.

Añade el assistant como bot a tu [espacio de trabajo de Slack](/es/ai/slack-bot) o [servidor de Discord](/es/ai/discord) para que tu comunidad pueda hacer preguntas sin salir de su plataforma preferida.

<div id="ui-placement">
### Ubicación en la interfaz de usuario
</div>
Expand Down
41 changes: 4 additions & 37 deletions es/ai/discord.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,53 +4,20 @@ description: "Agrega un bot a tu servidor de Discord que responda preguntas basa
keywords: ["Discord", "bot", "Q&A", "customer support"]
---

<Info>
Las integraciones de Discord están disponibles en los [planes Pro y Enterprise](https://mintlify.com/pricing?ref=discord), que incluyen acceso al assistant.
</Info>
<Warning>
Las nuevas instalaciones del bot de Discord ya no están disponibles a través del dashboard. Las integraciones existentes del bot de Discord continúan funcionando.
</Warning>

El bot de Discord ayuda a tu comunidad con respuestas en tiempo real basadas en tu documentación. El bot utiliza el assistant de Mintlify para buscar en tu documentación y proporcionar respuestas precisas con citas, de modo que siempre esté actualizada.

El bot solo funciona en canales públicos. Responde a menciones con `@` o a todos los mensajes en un canal específico.

Cada mensaje enviado por el bot de Discord se contabiliza dentro del uso de mensajes de tu assistant.

<div id="add-the-discord-bot-to-your-server">
## Agregar el bot de Discord a tu servidor
</div>

<Note>
Debes tener el permiso «Manage Server» en Discord para agregar el bot.
</Note>

1. Ve a la página [Assistant](https://dashboard.mintlify.com/products/assistant) en tu dashboard.
1. En la tarjeta de Discord, haz clic en **Configure**. Se abrirá Discord.
<Frame>
<img src="/images/assistant/connected-apps-light.png" alt="La sección Connected apps de la página del assistant." className="block dark:hidden" />
<img src="/images/assistant/connected-apps-dark.png" alt="La sección Connected apps de la página del assistant." className="hidden dark:block" />
</Frame>
1. En Discord, selecciona el servidor al que quieres agregar el bot.
1. Autoriza al bot para acceder a tu servidor.
1. Menciona al bot para agregarlo a un canal. El nombre predeterminado del bot es `@Mintlify Bot`.

<div id="create-an-ask-ai-channel">
## Crear un canal `#ask-ai`
</div>

Para ayudar a tu comunidad a obtener rápidamente respuestas a sus preguntas, el bot puede responder a cada mensaje en el canal que elijas. Por defecto, el bot responde a todos los mensajes en canales llamados `#ask-ai`. Crea un canal `#ask-ai` y avisa a tu comunidad de que el bot responde a los mensajes en ese canal.

Si quieres que el bot responda a mensajes en un canal diferente, selecciona un canal en el [menú de configuración](https://dashboard.mintlify.com/products/assistant/settings/integrations) del bot de Discord.

<Frame>
<img src="/images/assistant/discord-configure-light.png" alt="El panel de configuración de Discord en modo claro." className="block dark:hidden" />
<img src="/images/assistant/discord-configure-dark.png" alt="El panel de configuración de Discord en modo oscuro." className="hidden dark:block" />
</Frame>
Para ayudar a tu comunidad a obtener rápidamente respuestas a sus preguntas, el bot puede responder a cada mensaje en el canal que elijas. Por defecto, el bot responde a todos los mensajes en canales llamados `#ask-ai`. Crea un canal `#ask-ai` e indica a tu comunidad que el bot responde a los mensajes en ese canal.

Consulta [Starting Your First Discord Server](https://discord.com/blog/starting-your-first-discord-server) en el blog de Discord para obtener más información sobre cómo crear un canal.

<div id="manage-the-discord-bot">
## Administrar el bot de Discord
</div>

Después de agregar el bot de Discord a tu servidor, puedes administrar o eliminar el bot desde la pestaña [Integrations](https://dashboard.mintlify.com/products/assistant/settings/integrations) en tu dashboard.

En el menú de configuración del bot de Discord, puedes personalizarlo cambiando su avatar o nombre y elegir en qué canal responderá automáticamente a todos los mensajes.
42 changes: 4 additions & 38 deletions es/ai/slack-bot.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "Bot de Slack"
description: "Añade un bot a tu espacio de trabajo de Slack que responda preguntas basadas en tu documentación."
keywords: ["bot", "workspace", "Q&amp;A", "Slack", "app"]
keywords: ["bot", "workspace", "Q&A", "Slack", "app"]
---

<Info>
La aplicación de Slack está disponible para los [planes Pro y Custom](https://mintlify.com/pricing?ref=slack-app) con acceso al assistant.
</Info>
<Warning>
Las nuevas instalaciones del bot de Slack ya no están disponibles a través del dashboard. Las integraciones existentes del bot de Slack continúan funcionando.
</Warning>

La aplicación de Slack añade un bot a tu espacio de trabajo que ayuda a tu comunidad con respuestas en tiempo real. El bot utiliza el assistant de Mintlify para buscar en tu documentación y ofrecer respuestas precisas con citas, de modo que siempre esté al día.

Expand All @@ -16,42 +16,8 @@ El bot responde a las menciones con `@` o a todos los mensajes en un canal espec

Cada mensaje enviado por el bot se descuenta de tu uso de mensajes del assistant.

<div id="set-up-the-slack-app">
## Configurar la app de Slack
</div>

<Note>
Solo puedes instalar la app de Slack una vez en cada espacio de trabajo. Si tienes varias implementaciones de Mintlify, solo puedes conectar una implementación a la vez a un espacio de trabajo. Debes desconectar la app de una implementación antes de conectarla a otra.
</Note>

Si el propietario de tu espacio de trabajo de Slack requiere aprobación de un administrador para instalar apps, pídele que apruebe la app de Slack de Mintlify antes de que la agregues.

1. Ve a la página [Assistant](https://dashboard.mintlify.com/products/assistant) en tu dashboard.
1. En la tarjeta de Slack, haz clic en **Configure**. Esto abrirá Slack.
<Frame>
<img src="/images/assistant/connected-apps-light.png" alt="La sección de apps conectadas de la página del assistant." className="block dark:hidden" />
<img src="/images/assistant/connected-apps-dark.png" alt="La sección de apps conectadas de la página del assistant." className="hidden dark:block" />
</Frame>
1. Sigue las indicaciones de Slack para agregar la app a tu espacio de trabajo.
1. Menciona al bot para agregarlo a un canal. El nombre predeterminado del bot es `@mintlify-assistant`.

<div id="create-an-ask-ai-channel">
## Crear un canal `#ask-ai`
</div>

Para ayudar a tus usuarios a obtener rápidamente respuestas a sus preguntas, el bot puede responder a cada mensaje en un canal que elijas. De forma predeterminada, el bot responde a todos los mensajes en canales llamados `#ask-ai`. Crea un canal `#ask-ai` e indica a tus usuarios que el bot responde a los mensajes en ese canal. Consulta [Create a channel](https://slack.com/help/articles/201402297-Create-a-channel) en el Centro de ayuda de Slack para obtener más información.

Si quieres que el bot responda a los mensajes en un canal diferente, selecciona un canal en el [menú de configuración](https://dashboard.mintlify.com/products/assistant/settings/integrations) del bot de Slack.

<Frame>
<img src="/images/assistant/slack-configure-light.png" alt="El panel de configuración de Slack en modo claro." className="block dark:hidden" />
<img src="/images/assistant/slack-configure-dark.png" alt="El panel de configuración de Slack en modo oscuro." className="hidden dark:block" />
</Frame>

<div id="manage-the-slack-app">
## Administrar la aplicación de Slack
</div>

Después de añadir la aplicación a tu espacio de trabajo, puedes administrarla o eliminarla desde la pestaña [Integrations](https://dashboard.mintlify.com/products/assistant/settings/integrations).

En el menú de configuración del bot de Slack, personaliza el bot cambiando su avatar o nombre, y elige en qué canal responderá automáticamente a todos los mensajes.
8 changes: 0 additions & 8 deletions fr/ai/assistant.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,12 +195,6 @@ Si vous souhaitez interdire les dépassements, désactivez-les dans la section *

Dans la section Billing Controls, configurez des alertes d’utilisation pour recevoir un e-mail lorsque vous atteignez un certain pourcentage de votre quota de messages.

<div id="connect-apps">
## Connecter des applications
</div>

Dans la section Connecter des applications, ajoutez l&#39;Assistant à votre serveur [Discord](/fr/ai/discord) et à votre espace de travail [Slack](/fr/ai/slack-bot) pour permettre aux utilisateurs d&#39;obtenir des réponses à partir de votre documentation directement depuis ces plateformes.

<div id="assistant-insights">
## Informations de l’Assistant
</div>
Expand Down Expand Up @@ -242,8 +236,6 @@ Vous pouvez également configurer des alertes d&#39;utilisation pour recevoir un

Les utilisateurs disposent de plusieurs manières de démarrer une conversation avec l’Assistant. Chaque méthode ouvre un panneau de discussion sur le côté droit de votre documentation. Les utilisateurs peuvent poser n’importe quelle question et l’Assistant recherche une réponse dans votre documentation. Si l’Assistant ne parvient pas à récupérer d’informations pertinentes, l’Assistant indique qu’il ne peut pas répondre à la question.

Ajoutez l’Assistant en tant que bot à votre [espace de travail Slack](/fr/ai/slack-bot) ou à votre [serveur Discord](/fr/ai/discord) afin que votre communauté puisse poser des questions sans quitter sa plateforme préférée.

<div id="ui-placement">
### Emplacement dans l’interface
</div>
Expand Down
Loading
Loading