Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 13 additions & 8 deletions agent/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,33 +19,34 @@
## Connect your Slack workspace

<Note>
The Slack agent is not available for [Bitbucket Cloud](/deploy/bitbucket) projects.

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

Each Slack workspace can connect to only one Mintlify organization at a time. If you try to install the agent into a workspace that is already connected to a different organization, the installation fails with a "wrong organization" error. Uninstall the app from the other organization first, or use a different Slack workspace.

You can install the Slack agent even if you don't have a Mintlify-hosted project. The agent still works for question answering and conversations. Features that open pull requests require a connected repository.

If your Git provider is behind an IP allowlist, allow the Mintlify egress IP `54.242.90.151` so the agent can clone your repository. Contact support to opt in.
</Note>

1. Open your [Automations](https://app.mintlify.com/settings/project/automations) settings.
2. Click **Connect Slack**.
3. Follow the Slack prompts to install the `mintlify` app in your workspace and grant the requested permissions.
4. Confirm the connection in your Mintlify dashboard to your Slack workspace.
5. Test that the agent is working and responds when you:
4. Test that the agent responds when you:
- Send it a message in its **Chat** tab.
- Mention the agent with `@mintlify` in a channel.

<Tip>
On Enterprise plans, you can start from the [Integrations](https://app.mintlify.com/settings/organization/integrations) page in your dashboard settings instead. Click **Connect** next to Slack, then continue from step 3.
</Tip>

<Warning>
On Slack Enterprise Grid, you must install the app to the specific workspace where you want to use the agent. If you skip this step, the agent appears available at the organization level but does not respond in your workspace.

To add the app to a workspace, open your organization's app management page (a URL like `https://app.slack.com/manage/<your-org-id>/integrations/installed`). Find the `mintlify` app and install it to your workspace.
</Warning>

<Note>
The Slack agent is not available for [Bitbucket Cloud](/deploy/bitbucket) projects.

If your Git provider is behind an IP allowlist, allow the Mintlify egress IP `54.242.90.151` so the agent can clone your repository. Contact support to opt in.
</Note>

### Disconnect the agent

To remove the agent from your Slack workspace:
Expand All @@ -56,6 +57,10 @@
4. In Slack, navigate to **Manage apps**.
5. Click **Remove** on the Mintlify app.

<Tip>
On Enterprise plans, you can start from the [Integrations](https://app.mintlify.com/settings/organization/integrations) page instead. Click **Configure** next to Slack, click **Disconnect** and confirm, then continue from step 4.
</Tip>

When you disconnect the Slack app, the agent stops responding to mentions and direct messages, and automations that post to Slack stop delivering notifications.

### Reconnect or reinstall the agent
Expand Down Expand Up @@ -160,7 +165,7 @@
When the agent is working on your request, it provides feedback in the Slack thread.

- **Progress**: A progress indicator shows in the thread while the agent works. The agent removes it when it posts its reply.
- **Questions**: If your request is ambiguous, the agent asks a short question. Answer in the same thread or chat, mentioning `@mintlify` if you are in a channel.

Check warning on line 168 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L168

Did you really mean 'mentionin'?
- **New messages**: If you message the agent in the same thread or chat while it is still working, it acknowledges your message and folds it into the current task.
- **Busy**: If you mention the agent in a thread while it is busy with work from another thread, it posts a message saying so. It starts on your request when that work finishes.
- **Completion**: When the agent finishes, it posts its reply in the thread with links to the pages, pull requests, or live docs it changed.
Expand Down
4 changes: 3 additions & 1 deletion automations/integrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
| **Automation trigger** | Starts a custom automation when a selected event occurs in a supported shared integration or when a new message posts to a selected Slack channel. |

<Note>
The [Mintlify Slack app](/agent/slack) is separate from the third-party integrations on this page. Installing the Slack app adds the agent to your workspace and gives it read access to Slack content. You do not connect Slack from the **Integrations** settings page or select it in an automation's **Integrations** field. After you install the Slack app, you can select Slack as a custom automation trigger and the [editor agent](/editor/agent#read-your-slack-workspace) can read your workspace for context.
The [Mintlify Slack app](/agent/slack) works differently from the third-party integrations on this page. Installing the Slack app adds the agent to your workspace and gives it read access to Slack content. You can install it from the **Integrations** settings page, but you cannot select Slack in an automation's **Integrations** field. After you install the Slack app, you can select Slack as a custom automation trigger and the [editor agent](/editor/agent#read-your-slack-workspace) can read your workspace for context.
</Note>

## Connection scope
Expand Down Expand Up @@ -78,7 +78,7 @@
| Stripe | Shared | Yes |
| Zendesk | Shared | Yes |

Google Drive and Google Docs are shared integrations. If a teammate connected either one as a personal integration before it became shared, the agent no longer uses that connection. An admin or editor must connect it again for your organization.

Check warning on line 81 in automations/integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/integrations.mdx#L81

In general, use active voice instead of passive voice ('are shared').

## Use integrations with the Slack agent

Expand Down Expand Up @@ -157,6 +157,8 @@

Disconnecting a personal integration only removes your connection. Other teammates keep their personal connections.

To disconnect Slack, see [Disconnect the agent](/agent/slack#disconnect-the-agent).

## Troubleshoot a connection

If an integration stops working:
Expand Down
2 changes: 1 addition & 1 deletion mint-instructions/automate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
- Fail a PR on broken builds or links, in any CI, any plan: add `mint validate` and `mint broken-links` to the user's own CI (below).
- Broken internal links and Vale prose linting on GitHub PRs, no CI file: Mintlify CI checks (Pro or Enterprise, GitHub only).
- Recurring or triggered doc updates (code merged, content pushed, schedule, integration event, webhook): an automation (Enterprise).
- "Just keep docs up to date", no prompts or triggers to configure: Autopilot (Pro or Enterprise, on GitHub, GitLab including self-hosted, or Azure Repos).

Check warning on line 15 in mint-instructions/automate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/automate.mdx#L15

Commas and periods go inside quotation marks.
- One-off or exploratory change: the Mintlify agent in Slack, the web editor, or the dashboard.

## Workflow
Expand All @@ -20,15 +20,15 @@
1. Run `mint status` to confirm account and subdomain. Ask the plan if a step needs Pro or Enterprise.
2. CI in their repo: add the Examples job yourself.
3. Mintlify CI checks: tell the user to enable them on the dashboard **Site** settings page (https://app.mintlify.com/settings/project/site), choosing `Warning` (never fails) or `Blocking` (fails on errors or suggestions). Needs the Mintlify GitHub App. Optional: commit a `.vale.ini` in the content root (use relative `StylesPath = styles`, no absolute paths or `..`) and `styles/config/vocabularies/Mintlify/accept.txt` / `reject.txt`.
4. Agent guidance: write `.mintlify/AGENTS.md`. A root `AGENTS.md` also works but is served publicly at `/agents.md` unless you add it to `.mintignore`. The Mintlify agent reads only `AGENTS.md`, not `CLAUDE.md`, `.cursorrules` or similar, so copy shared rules in. The editor agent ignores `AGENTS.md`; it uses **AI instructions** in editor settings.

Check warning on line 23 in mint-instructions/automate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/automate.mdx#L23

Use 'Claude' instead of 'CLAUDE'.
5. Automations: the user creates and manages them on the **Automations** page of the dashboard. Help them choose a name, trigger, and prompt. Prompts: one task, numbered steps, exact paths, done state.
6. Test: user clicks **Test run** / **Run now** and picks a scope (**Since a date**, **Everything**, **Specific pull request**). Not available for Integration or Webhook triggers. Check the **Runs** tab.
7. Autopilot: user opens https://app.mintlify.com/products/autopilot, switches on the toggle, picks **Additional repositories** under GitHub **Configure** (GitLab: **Additional projects**, after connecting projects through GitLab OAuth in Git settings. Azure Repos: **Configure** in the **Azure Repos** row), and uses **Chat to configure** to change reviewers, target branch, or schedule.
8. Slack agent: user clicks **Connect Slack** on the Automations page and installs the `mintlify` app (workspace admin approval may be needed; on Enterprise Grid install to the specific workspace). Test with a DM or `@mintlify` in a channel. The Slack agent also chats with Autopilot: ask about its work or change what it works on. Not available for Bitbucket Cloud projects.
8. Slack agent: user clicks **Connect Slack** on the Automations page (on Enterprise, they can instead click **Connect** next to Slack on the organization **Integrations** settings page) and installs the `mintlify` app (workspace admin approval may be needed; on Enterprise Grid install to the specific workspace). Test with a DM or `@mintlify` in a channel. The Slack agent also chats with Autopilot: ask about its work or change what it works on. Not available for Bitbucket Cloud projects.

Check warning on line 27 in mint-instructions/automate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/automate.mdx#L27

In general, use active voice instead of passive voice ('be needed').

## What each piece does

- The Mintlify agent: researches docs, connected repos and the web, plans, writes, runs CLI checks, then opens a PR or commits to the deploy branch (**Agent review process** in **Slack settings**: **Create a pull request** or **Push to main**; branch protection forces a PR). Name a branch in the prompt to target it. Only reads repos with the Mintlify GitHub App (GitLab: Git Settings); other repos are read-only context. Slack viewers get read-only.

Check warning on line 31 in mint-instructions/automate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/automate.mdx#L31

In general, use active voice instead of passive voice ('are read').
- Web editor agent: **Ask agent** or Cmd/Ctrl+J; edits the current branch.
- Automations: one trigger each. **Content update** (push to docs repo), **Code change** (PR merged in source repos; per-repo path filters and excluded authors, up to 50 repos), **Custom schedule** (presets or 5-field cron), **Integration** (custom only), **Webhook** (custom only, `POST` with `Authorization: Bearer <api-key>`, an organization API key with write access).
- Predefined: Update from code changes (needs a source repo, default twice weekly), Draft changelog, Fill gaps from assistant conversations, Improve docs from user feedback (feedback collection on), Update from support feedback (Intercom, Plain, Pylon, or Zendesk), Translate content (needs a target language, direct merge), Fix broken links, Fix SEO issues, Fix grammar & typos, Enforce your style guide. Custom: your own prompt.
Expand All @@ -45,7 +45,7 @@

## Rules

- Never claim Autopilot, Mintlify CI checks, the Slack app, or an automation is set up: only the user can do those in the dashboard.

Check warning on line 48 in mint-instructions/automate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/automate.mdx#L48

In general, use active voice instead of passive voice ('is set').
- Mintlify CI checks do not check external links; use `mint broken-links --check-external`.
- If the Git provider uses an IP allow list, the user emails support@mintlify.com to route through `54.242.90.151`, then allows that IP.
- GitLab automations need a paid GitLab tier and Maintainer role per project. Automations also support GHES repos.
Expand Down Expand Up @@ -84,5 +84,5 @@
- `mint instructions publish` for deploys, previews, and CI context.
- https://www.mintlify.com/docs/automations/index
- https://www.mintlify.com/docs/automations/reference
- https://www.mintlify.com/docs/deploy/ci

Check warning on line 87 in mint-instructions/automate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/automate.mdx#L87

Use 'CI' instead of 'ci'.
- https://www.mintlify.com/docs/agent/slack

Check warning on line 88 in mint-instructions/automate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/automate.mdx#L88

Use 'Slack' instead of 'slack'.
Loading