diff --git a/agent/index.mdx b/agent/index.mdx index 58e005626..272d97eb1 100644 --- a/agent/index.mdx +++ b/agent/index.mdx @@ -10,25 +10,25 @@ import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx"; The agent is available on [Pro and Enterprise plans](https://mintlify.com/pricing?ref=agent). -The agent is an AI tool that creates pull requests with proposed changes to your documentation based on your prompts. When you send a request, the agent: +The agent is an AI tool that creates pull requests (or merge requests, for GitLab) with proposed changes to your documentation based on your prompts. When you send a request, the agent: - **Researches**: Searches and reads your existing documentation, any connected repositories, relevant context, and the web. - **Plans**: Creates a structured task list for complex documentation work. - **Writes**: Generates or updates content following writing standards and best practices. - **Validates**: Runs Mintlify CLI checks to ensure documentation builds correctly. -- **Creates a PR**: Opens a pull request with proposed changes for review. +- **Creates a PR**: Opens a pull request or merge request with proposed changes for review. -All changes go through pull requests. The agent never commits directly to your main branch. +All changes go through pull requests or merge requests. The agent never commits directly to your deploy branch. ## What you can do with the agent Use the agent to: -- Write new content based on your prompts, pull requests, Slack threads, or file attachments. +- Write new content based on your prompts, pull requests, merge requests, Slack threads, or file attachments. - 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 GitHub repository that has the Mintlify GitHub App installed. - Automate documentation maintenance with workflows. - Answer questions about your docs and technical writing topics. - Address code review feedback to maintain documentation quality. @@ -41,7 +41,12 @@ 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 uses your existing deployment connection to read and write to your docs repository: + +- **GitHub**: The agent uses the [Mintlify GitHub App](/deploy/github). 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). +- **GitLab**: The agent uses the [GitLab integration](/deploy/gitlab) that you set up for deployments. The agent opens merge requests against your deploy branch using the project access token you connected. + +Additional source repositories that the agent references for context must be GitHub repositories with the Mintlify GitHub App installed. ## Use AI tools alongside the agent diff --git a/agent/slack.mdx b/agent/slack.mdx index 5bf7c569b..988c71cff 100644 --- a/agent/slack.mdx +++ b/agent/slack.mdx @@ -84,7 +84,7 @@ Once connected, you can: - 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. -- Share pull request links with the agent to update related documentation. +- Share pull request or merge request links with the agent to update related documentation. ## Ask questions about your docs @@ -106,11 +106,20 @@ Use the agent to update your documentation with a new request or in an existing - **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. -The agent reads the context of the request or thread and creates a pull request in your connected repository with the updates. +The agent reads the context of the request or thread and creates a pull request (or a merge request, for GitLab-connected deployments) in your connected repository with the updates. + +### GitHub and GitLab support + +The Slack agent works with both GitHub and GitLab deployments: + +- **GitHub-connected deployments**: The agent opens pull requests through the [Mintlify GitHub App](/deploy/github). The completion message links to the pull request on GitHub. +- **GitLab-connected deployments**: The agent opens merge requests through your [GitLab integration](/deploy/gitlab), using the project access token you configured for the deployment. The completion message links to the merge request on GitLab (or your self-hosted GitLab instance). + +No additional setup is required—the agent automatically detects which Git provider your deployment uses and creates the appropriate change request. ## 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 GitHub 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. When you mention another repository in your request, the agent clones it on demand and inspects the relevant files before drafting changes. @@ -120,7 +129,7 @@ Example prompts: - "Document the new endpoints added in `acme/backend#1234`." - "What repositories do you have access to?" -The agent treats cloned repositories as read-only. It uses them for context, but always opens pull requests against your documentation repository. +The agent treats cloned repositories as read-only. It uses them for context, but always opens pull requests or merge requests against your documentation repository. ## Track progress in real time @@ -131,13 +140,13 @@ When the agent is making changes to your documentation, it provides live feedbac - **Questions**: If the agent needs more information, it presents options for you to select from or reply in the thread with a custom answer. - **Permission requests**: Before the agent runs a third-party action that writes data, such as sending an email or creating a ticket, it asks you to approve or deny the action. The permission request is only visible to the person who triggered the request. Click **Approve** to let the agent proceed or **Deny** to cancel the action. - **Interruptions**: If you send a follow-up message while the agent is still working, it stops the current task and starts on the new one. -- **Completion**: When the agent finishes, it posts a summary with a link to the pull request and a link to open the changes in the web editor. +- **Completion**: When the agent finishes, it posts a summary with a link to the pull request or merge request and a link to open the changes in the web editor. ## Roles and permissions The agent's capabilities in Slack match users' [roles](/dashboard/roles). -- **Admins and editors**: Can ask questions and make documentation changes. The agent has access to file editing and pull request tools. +- **Admins and editors**: Can ask questions and make documentation changes. The agent has access to file editing and pull request or merge request tools. - **Viewers**: Can ask questions only. The agent runs in read-only mode for Mintlify tools and third-party integrations. To change a teammate's permissions, update their role on the [Members](https://dashboard.mintlify.com/settings/organization/members) page of your dashboard. @@ -146,4 +155,4 @@ To change a teammate's permissions, update their role on the [Members](https://d - **Be specific**: Tell the agent exactly what you want to know or what you want changed and where. - **Add context**: If a thread doesn't contain all the necessary information, include additional details in your message to the agent. -- **Review carefully**: You should always review pull requests that the agent creates before merging them. +- **Review carefully**: You should always review pull requests or merge requests that the agent creates before merging them. diff --git a/es/agent/index.mdx b/es/agent/index.mdx index e2d7e928d..0138afae5 100644 --- a/es/agent/index.mdx +++ b/es/agent/index.mdx @@ -8,15 +8,15 @@ keywords: ["automation", "automate", "AI", "autoupdate", "maintenance"] El agente está disponible en los [planes Pro y Enterprise](https://mintlify.com/pricing?ref=agent). -El agente es una herramienta de IA que crea solicitudes de extracción (pull requests) con cambios propuestos para tu documentación a partir de tus indicaciones. Cuando envías una solicitud, el agente: +El agente es una herramienta de IA que crea pull requests (o merge requests, en GitLab) con cambios propuestos para tu documentación a partir de tus indicaciones. Cuando envías una solicitud, el agente: * **Investiga**: Busca y lee tu documentación existente, los repositorios conectados, el contexto relevante y la web. * **Planifica**: Crea una lista de tareas estructurada para trabajos de documentación complejos. * **Escribe**: Genera o actualiza contenido siguiendo los estándares y las mejores prácticas de redacción. * **Valida**: Ejecuta comprobaciones con Mintlify CLI para asegurarse de que la documentación se compile correctamente. -* **Crea una PR**: Abre una solicitud de extracción con cambios propuestos para revisión. +* **Crea una PR**: Abre un pull request o merge request con los cambios propuestos para su revisión. -Todos los cambios pasan por solicitudes de extracción (pull requests). El agente nunca realiza confirmaciones directamente en tu branch principal. +Todos los cambios pasan por pull requests o merge requests. El agente nunca realiza confirmaciones directamente en tu branch de despliegue.