Skip to content

docs: document GitLab support for the Slack agent #5951

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

Closed
mintlify-development wants to merge 1 commit into from
Closed

docs: document GitLab support for the Slack agent #5951

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
4 changes: 2 additions & 2 deletions agent/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Use the agent to:
- Update existing documentation for new features or API changes.
- Process and include images, diagrams, and other files from Slack attachments.
- Search and revise code examples and API references across your docs.
- Reference source code from any repository that has the Mintlify GitHub App installed.
- Reference source code from any repository connected through the Mintlify GitHub App or GitLab integration.
- Automate documentation maintenance with workflows.
- Answer questions about your docs and technical writing topics.
- Address code review feedback to maintain documentation quality.
Expand All @@ -41,7 +41,7 @@ By default, the agent opens pull requests attributed to the Mintlify bot. To att

## Connect repositories as context

The agent can only access repositories that you connect through the Mintlify GitHub App. Configure which repositories the agent can access in the agent panel **Settings** or in the [GitHub App settings](https://github.com/apps/mintlify/installations/new).
The agent can only access repositories that you connect through the [Mintlify GitHub App](/deploy/github) or the [GitLab integration](/deploy/gitlab). Configure which repositories the agent can access in the agent panel **Settings** or in the [GitHub App settings](https://github.com/apps/mintlify/installations/new). For GitLab-hosted projects, manage access from your GitLab integration settings in the dashboard.

## Use AI tools alongside the agent

Expand Down
7 changes: 5 additions & 2 deletions agent/slack.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,14 @@
conversation by clicking the **Switch deployment** button on the agent's status
message in the thread. The agent retains your conversation history so you can
continue where you left off with the new deployment.

Switching deployments mid-thread is not supported when your current deployment
is connected to GitLab. Start a new thread to work with a different deployment.

Check warning on line 45 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L45 

In general, use active voice instead of passive voice ('is connected').
</Tip>

## Connect additional integrations from Slack

After you connect your Slack workspace, you can ask the agent in Slack to set up any third-party integration that it should use as context. The agent uses [Composio](https://docs.composio.dev/toolkits) to support a broad catalog of third-party services, including issue trackers, knowledge bases, CRMs, and developer tools.

Check warning on line 50 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L50 

Did you really mean 'CRMs'?

<Note>
You must configure GitHub and GitLab through Mintlify, not Composio. Use the [GitHub app](/deploy/github) or [GitLab integration](/deploy/gitlab) to control which repositories the agent can access.
Expand All @@ -68,7 +71,7 @@

### Expired or revoked connections

Mintlify keeps the status of your connected services in sync with Composio. A connection is disconnected when:

Check warning on line 74 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L74 

In general, use active voice instead of passive voice ('is disconnected').

- The third-party provider expires or revokes the credentials.
- The provider marks the connection as inactive.
Expand All @@ -83,7 +86,7 @@
- Send direct messages to the agent to use it privately.
- Mention `@mintlify` in a channel to use it publicly and collaboratively.
- Attach files and images directly to your messages for the agent to process and include in your docs.
- Continue conversations in threads to iterate on changes or ask follow-up questions. The agent reuses files and images shared earlier in the thread as context for follow-up requests, so you don't have to reupload them.

Check warning on line 89 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L89 

Did you really mean 'reupload'?
- Share pull request links with the agent to update related documentation.

## Ask questions about your docs
Expand All @@ -95,7 +98,7 @@

Example questions:
- "Which pages mention the API rate limit?"
- "How do I set up authentication?"

Check warning on line 101 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L101 

Avoid first-person pronouns such as ' I '.
- "How is our navigation structured?"

## Update documentation
Expand All @@ -104,15 +107,15 @@

- **New request**: Send a direct message to the agent or mention `@mintlify` in a channel with instructions on what to update.
- **Existing thread**: Reply in the thread and mention `@mintlify` with instructions on what to update.
- **With attachments**: Upload images, diagrams, code files, or other documents with your message. The agent automatically processes and includes them in your documentation. In a thread, the agent has access to images and files shared in earlier messages, so you can reference them in follow-up requests without reuploading.

Check warning on line 110 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L110 

Did you really mean 'reuploading'?

The agent reads the context of the request or thread and creates a pull request in your connected repository with the updates.

## Reference other repositories

The agent can read source code from any repository that has the Mintlify GitHub App installed, even if it isn't your documentation repository. This lets the agent build deeper context to guide documentation updates.
The agent can read source code from any repository connected through the [Mintlify GitHub App](/deploy/github) or [GitLab integration](/deploy/gitlab), even if it isn't your documentation repository. This lets the agent build deeper context to guide documentation updates.

When you mention another repository in your request, the agent clones it on demand and inspects the relevant files before drafting changes.
When you mention another repository in your request, the agent clones it on demand and inspects the relevant files before drafting changes. The agent uses GitHub or GitLab credentials based on which provider hosts the repository.

Example prompts:

Expand Down
4 changes: 2 additions & 2 deletions es/agent/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Usa el agente para:
* Actualizar documentación existente con nuevas funcionalidades o cambios en la API.
* Procesar e incluir imágenes, diagramas y otros archivos a partir de archivos adjuntos de Slack.
* Buscar y revisar ejemplos de código y referencias de API en toda tu documentación.
* Hacer referencia al código fuente de cualquier repositorio que tenga instalada la aplicación de GitHub de Mintlify.
* Hacer referencia al código fuente de cualquier repositorio conectado mediante la GitHub App de Mintlify o la integración con GitLab.
* Automatizar el mantenimiento de la documentación mediante flujos de trabajo.
* Responder preguntas sobre tu documentación y temas de redacción técnica.
* Atender comentarios de revisión de código para mantener la calidad de la documentación.
Expand All @@ -45,7 +45,7 @@ De forma predeterminada, el agente abre solicitudes de extracción a nombre del
## Conecta repositorios como contexto
</div>

El agente solo puede acceder a los repositorios que conectes mediante la Aplicación de GitHub de Mintlify. Configura a qué repositorios puede acceder el agente en la sección **Settings** del panel del agente o en la [configuración de la Aplicación de GitHub](https://github.com/apps/mintlify/installations/new).
El agente solo puede acceder a los repositorios que conectes mediante la [GitHub App de Mintlify](/es/deploy/github) o la [integración con GitLab](/es/deploy/gitlab). Configura a qué repositorios puede acceder el agente en la sección **Settings** del panel del agente o en la [configuración de la Aplicación de GitHub](https://github.com/apps/mintlify/installations/new). Para los proyectos alojados en GitLab, gestiona el acceso desde la configuración de la integración con GitLab en tu panel.

<div id="use-ai-tools-alongside-the-agent">
## Usa herramientas de IA junto con el agente
Expand Down
8 changes: 6 additions & 2 deletions es/agent/slack.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ a otros miembros del equipo. Puedes cambiar a un despliegue diferente en cualqui
momento durante una conversación haciendo clic en el botón **Switch deployment** en
el mensaje de estado del agente en el hilo. El agente conserva tu historial de
conversación para que puedas continuar donde lo dejaste con el nuevo despliegue.

Cambiar de despliegue en medio de un hilo no es compatible cuando tu despliegue
actual está conectado a GitLab. Inicia un nuevo hilo para trabajar con un
despliegue diferente.
</Tip>

<div id="connect-additional-integrations-from-slack">
Expand Down Expand Up @@ -124,9 +128,9 @@ El agente lee el contexto de la solicitud o del hilo y crea una solicitud de ext
## Hacer referencia a otros repositorios
</div>

El agente puede leer el código fuente de cualquier repositorio que tenga instalada la aplicación de GitHub de Mintlify, incluso si no es tu repositorio de documentación. Esto le permite construir un contexto más profundo para guiar las actualizaciones de la documentación.
El agente puede leer el código fuente de cualquier repositorio conectado mediante la [GitHub App de Mintlify](/es/deploy/github) o la [integración con GitLab](/es/deploy/gitlab), incluso si no es tu repositorio de documentación. Esto le permite construir un contexto más profundo para guiar las actualizaciones de la documentación.

Cuando mencionas otro repositorio en tu solicitud, el agente lo clona bajo demanda e inspecciona los archivos relevantes antes de redactar los cambios.
Cuando mencionas otro repositorio en tu solicitud, el agente lo clona bajo demanda e inspecciona los archivos relevantes antes de redactar los cambios. El agente utiliza credenciales de GitHub o GitLab según el proveedor que aloje el repositorio.

Ejemplos de prompts:

Expand Down
4 changes: 2 additions & 2 deletions fr/agent/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Utilisez l’agent pour :
* Mettre à jour la documentation existante pour de nouvelles fonctionnalités ou des évolutions d’API.
* Traiter et intégrer des images, des schémas et d’autres fichiers à partir des pièces jointes Slack.
* Rechercher et réviser des exemples de code et des références d’API dans l’ensemble de votre documentation.
* Référencer le code source de n’importe quel dépôt sur lequel la GitHub App Mintlify est installée.
* Référencer le code source de n’importe quel dépôt connecté via la GitHub App Mintlify ou l’intégration GitLab.
* Automatiser la maintenance de la documentation avec des workflows.
* Répondre aux questions sur votre documentation et sur des sujets de rédaction technique.
* Traiter les retours de revue de code pour maintenir la qualité de la documentation.
Expand All @@ -45,7 +45,7 @@ Par défaut, l'agent ouvre des pull requests (demandes de fusion) attribuées au
## Connecter des dépôts en tant que contexte
</div>

L’agent ne peut accéder qu’aux dépôts que vous connectez via la GitHub App de Mintlify. Configurez les dépôts auxquels l’agent peut accéder dans le panneau **Settings** de l’agent ou dans les [paramètres de la GitHub App](https://github.com/apps/mintlify/installations/new).
L’agent ne peut accéder qu’aux dépôts que vous connectez via la [GitHub App de Mintlify](/fr/deploy/github) ou l’[intégration GitLab](/fr/deploy/gitlab). Configurez les dépôts auxquels l’agent peut accéder dans le panneau **Settings** de l’agent ou dans les [paramètres de la GitHub App](https://github.com/apps/mintlify/installations/new). Pour les projets hébergés sur GitLab, gérez les accès depuis les paramètres de l’intégration GitLab dans votre tableau de bord.

<div id="use-ai-tools-alongside-the-agent">
## Utiliser des outils d'IA en complément de l'agent
Expand Down
8 changes: 6 additions & 2 deletions fr/agent/slack.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ moment pendant une conversation en cliquant sur le bouton **Switch deployment**
le message de statut de l'agent dans le fil. L'agent conserve votre historique de
conversation afin que vous puissiez reprendre là où vous en étiez avec le nouveau
déploiement.

Le changement de déploiement en cours de fil n'est pas pris en charge lorsque
votre déploiement actuel est connecté à GitLab. Démarrez un nouveau fil pour
travailler avec un déploiement différent.
</Tip>

<div id="connect-additional-integrations-from-slack">
Expand Down Expand Up @@ -125,9 +129,9 @@ L'agent lit le contexte de la demande ou du fil et crée une pull request (deman
## Référencer d'autres dépôts
</div>

L'agent peut lire le code source de n'importe quel dépôt sur lequel la GitHub App Mintlify est installée, même s'il ne s'agit pas de votre dépôt de documentation. Cela lui permet de construire un contexte plus approfondi pour guider les mises à jour de la documentation.
L'agent peut lire le code source de n'importe quel dépôt connecté via la [GitHub App Mintlify](/fr/deploy/github) ou l'[intégration GitLab](/fr/deploy/gitlab), même s'il ne s'agit pas de votre dépôt de documentation. Cela lui permet de construire un contexte plus approfondi pour guider les mises à jour de la documentation.

Lorsque vous mentionnez un autre dépôt dans votre demande, l'agent le clone à la demande et examine les fichiers pertinents avant de rédiger les modifications.
Lorsque vous mentionnez un autre dépôt dans votre demande, l'agent le clone à la demande et examine les fichiers pertinents avant de rédiger les modifications. L'agent utilise les identifiants GitHub ou GitLab selon le fournisseur qui héberge le dépôt.

Exemples de prompts :

Expand Down
4 changes: 2 additions & 2 deletions zh/agent/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ agent 是一款 AI 工具，会根据你的提示，为文档创建包含建议
* 根据新功能或 API 变更更新现有文档。
* 处理并插入来自 Slack 附件的图片、图表和其他文件。
* 在你的文档中搜索并修改代码示例和 API 参考。
* 引用任何已安装 Mintlify GitHub 应用的仓库中的源代码。
* 引用任何通过 Mintlify GitHub 应用或 GitLab 集成连接的仓库中的源代码。
* 通过工作流自动化文档维护工作。
* 回答与你的文档和技术写作相关的问题。
* 处理代码审查反馈并维护文档质量。
Expand All @@ -45,7 +45,7 @@ agent 是一款 AI 工具，会根据你的提示，为文档创建包含建议
## 将仓库连接为上下文
</div>

Agent 只能访问你通过 Mintlify GitHub 应用连接的仓库。你可以在 agent 面板的 **Settings** 中，或在 [GitHub 应用设置](https://github.com/apps/mintlify/installations/new) 中配置 agent 可访问的仓库。
Agent 只能访问你通过 [Mintlify GitHub 应用](/zh/deploy/github)或 [GitLab 集成](/zh/deploy/gitlab)连接的仓库。你可以在 agent 面板的 **Settings** 中，或在 [GitHub 应用设置](https://github.com/apps/mintlify/installations/new) 中配置 agent 可访问的仓库。对于托管在 GitLab 上的项目，请在控制台的 GitLab 集成设置中管理访问权限。

<div id="use-ai-tools-alongside-the-agent">
## 与 agent 配合使用 AI 工具
Expand Down
6 changes: 4 additions & 2 deletions zh/agent/slack.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ keywords: ["Slack 集成", "Slack 机器人", "团队协作", "agent 集成", "

你的首选部署仅与你的 Slack 账户关联，不会影响其他团队成员。你可以在对话过程中随时切换到其他部署，只需点击线程中 agent 状态消息上的
**Switch deployment** 按钮。Agent 会保留你的对话历史记录，以便你在新部署上从之前中断的地方继续。

当你当前的部署连接到 GitLab 时，不支持在线程中途切换部署。请开启新线程以使用其他部署。
</Tip>

<div id="connect-additional-integrations-from-slack">
Expand Down Expand Up @@ -121,9 +123,9 @@ Mintlify 会让你已连接服务的状态与 Composio 保持同步。当出现
## 引用其他仓库
</div>

智能体可以读取任何已安装 Mintlify GitHub 应用的仓库中的源代码，即使该仓库不是你的文档仓库。这让智能体能够构建更深入的上下文，以指导文档更新。
智能体可以读取通过 [Mintlify GitHub 应用](/zh/deploy/github)或 [GitLab 集成](/zh/deploy/gitlab)连接的任何仓库中的源代码，即使该仓库不是你的文档仓库。这让智能体能够构建更深入的上下文，以指导文档更新。

当你在请求中提到其他仓库时，智能体会按需克隆该仓库，并在起草更改之前检查相关文件。
当你在请求中提到其他仓库时，智能体会按需克隆该仓库，并在起草更改之前检查相关文件。智能体会根据托管该仓库的提供方使用对应的 GitHub 或 GitLab 凭据。

示例提示词：

Expand Down
Loading