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
5 changes: 4 additions & 1 deletion agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ All changes go through pull requests. The agent never commits directly to your m

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, Linear issues, 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.
Expand All @@ -45,6 +45,9 @@ The agent can only access repositories that you connect through the Mintlify Git
<Card title="Connect Slack" horizontal icon="slack" href="/agent/slack">
Add the agent to your Slack workspace.
</Card>
<Card title="Connect Linear" horizontal icon="linear" href="/agent/linear">
Add the agent to your Linear workspace.
</Card>
<Card title="Customize behavior" horizontal icon="wrench" href="/agent/customize">
Configure the agent with an `AGENTS.md` file.
</Card>
Expand Down
34 changes: 34 additions & 0 deletions agent/linear.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: "Add the agent to Linear"
description: "Use the agent in Linear to create documentation updates from issues and comments."
keywords: ["issue tracking", "project management"]
---

Connect your Linear workspace to the agent to make documentation updates from Linear. When you mention the Mintlify agent in a Linear comment or assign it to an issue, the agent builds context from the issue and opens a pull request with proposed changes to your documentation.

## Connect your Linear workspace

Check warning on line 9 in agent/linear.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/linear.mdx#L9

'Connect your Linear workspace' should use sentence-style capitalization.

1. Go to the [Agent](https://dashboard.mintlify.com/products/agent) page in your dashboard.
2. In the "Agent settings" section, click **Install Linear app**.
<Frame>
<img src="/images/agent/install-apps-light.png" alt="The App settings section with the Slack and Linear install buttonsi." className="block dark:hidden" />
<img src="/images/agent/install-apps-dark.png" alt="The App settings section with the Slack and Linear install buttons." className="hidden dark:block" />
</Frame>
3. Follow the Linear prompts to authorize the Mintlify app in your workspace.

## Use the agent in Linear

Once connected, mention `@mintlify` in a Linear issue or assign an issue to `Mintlify` to trigger a documentation update. The agent uses the issue's title, description, and comment thread for context, then opens a pull request in your documentation repository.

Use the agent in Linear to:

- **Update docs from feature issues**: When a feature ships, mention the agent in the issue to draft or update the relevant documentation.
- **Act on documentation feedback**: Create Linear issues for documentation improvements and mention the agent to make the changes.
- **Generate release notes**: Mention the agent in a release-related issue to draft changelog entries based on the issue details.
- **Fix reported problems**: When someone reports a docs issue in Linear, mention the agent to resolve it.

## Best practices

- **Include context in the issue**: The more context you provide in an issue, the better the resulting pull request.
- **Review pull requests**: Always review the pull requests that the agent creates before merging them.
- **Iterate in comments**: Reply in the same issue thread to refine the agent's output, similar to how you would in Slack.
23 changes: 11 additions & 12 deletions agent/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,17 @@ keywords: ["Slack integration", "Slack bot", "team collaboration", "agent integr

## Connect your Slack workspace

1. Open the agent panel in your dashboard.
2. Click the **Settings** button.
<Frame>
<img src="/images/agent/dashboard-settings-light.png" alt="The settings button in light mode." className="block dark:hidden" />
<img src="/images/agent/dashboard-settings-dark.png" alt="The settings button in dark mode." className="hidden dark:block" />
</Frame>
3. In the Slack integration section, click **Connect**.
4. Follow the Slack prompts to add the `mintlify` app to your workspace.
5. Follow the Slack prompts to link your Mintlify account to your Slack workspace.
6. Test that the agent is working and responds when you:
- Send a direct message to it.
- Mention it with `@mintlify` in a channel.
1. Go to the [Agent](https://dashboard.mintlify.com/products/agent) page in your dashboard.
2. In the "Agent settings" section, click **Install Slack app**.
<Frame>
<img src="/images/agent/install-apps-light.png" alt="The App settings section with the Slack and Linear install buttonsi." className="block dark:hidden" />
<img src="/images/agent/install-apps-dark.png" alt="The App settings section with the Slack and Linear install buttons." className="hidden dark:block" />
</Frame>
3. Follow the Slack prompts to install the `mintlify` app in your workspace.
4. Follow the Slack prompts to link your Mintlify account to your Slack workspace.
5. Test that the agent is working and responds when you:
- Send a direct message to the agent.
- Mention the agent with `@mintlify` in a channel.

## Use the agent in Slack

Expand Down
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@
"root": "agent/index",
"pages": [
"agent/slack",
"agent/linear",
"agent/workflows",
"agent/customize",
"agent/effective-prompts",
Expand Down
22 changes: 2 additions & 20 deletions guides/automate-agent.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Tutorial: Auto-update documentation when code is changed"

Check warning on line 2 in guides/automate-agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/automate-agent.mdx#L2

In general, use active voice instead of passive voice ('is changed').
sidebarTitle: "Automate documentation updates"
description: "Use the agent API to automatically update your documentation."
keywords: ["agent automation", "n8n", "GitHub Actions", "automatic doc updates"]
---

## What you will build

Check warning on line 8 in guides/automate-agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/automate-agent.mdx#L8

Avoid using 'will'.

An automation that updates your documentation when code is pushed to your main branch. The workflow can be built on multiple platforms, including GitHub Actions and n8n. It watches your code repository and then calls the agent API to update your documentation in a separate documentation repository.

Check warning on line 10 in guides/automate-agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/automate-agent.mdx#L10

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

Check warning on line 10 in guides/automate-agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/automate-agent.mdx#L10

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

This workflow connects two separate repositories:

Expand Down Expand Up @@ -41,18 +41,9 @@

### Install the Mintlify app on your code repository

The Mintlify app must be installed on your code repository so the agent can fetch context from your codebase. To add the app to new repositories:

Check warning on line 44 in guides/automate-agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/automate-agent.mdx#L44

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

1. Open the agent panel in your Mintlify dashboard.
<Frame>
<img src="/images/agent/dashboard-light.png" alt="The agent panel in light mode." className="block dark:hidden" />
<img src="/images/agent/dashboard-dark.png" alt="The agent panel in dark mode." className="hidden dark:block" />
</Frame>
1. Click the **Settings** button.
<Frame>
<img src="/images/agent/dashboard-settings-light.png" alt="The settings button in light mode." className="block dark:hidden" />
<img src="/images/agent/dashboard-settings-dark.png" alt="The settings button in dark mode." className="hidden dark:block" />
</Frame>
1. Go to the [Agent](https://dashboard.mintlify.com/products/agent) page in your dashboard.
1. Click **Add to New Organization**. This takes you to the app installation page on GitHub.
1. Select the repositories you want to grant access to from the list.
1. Save your changes.
Expand Down Expand Up @@ -179,17 +170,17 @@
## Troubleshooting

### Workflow not running
- Verify GitHub Actions is enabled in your code repository.

Check warning on line 173 in guides/automate-agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/automate-agent.mdx#L173

In general, use active voice instead of passive voice ('is enabled').
- Check the **Actions** tab for error messages.
- Ensure the workflow file is in `.github/workflows/` with a `.yml` extension.

### 401 error from agent API
- Verify your API key starts with `mint_`.
- Check the Authorization header is formatted as `Bearer mint_yourkey`.

Check warning on line 179 in guides/automate-agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/automate-agent.mdx#L179

In general, use active voice instead of passive voice ('is formatted').
- Confirm the API key is for the correct Mintlify organization.

### No documentation updates appearing
- Check that the documentation repository is connected to your Mintlify project.

Check warning on line 183 in guides/automate-agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/automate-agent.mdx#L183

In general, use active voice instead of passive voice ('is connected').
- Verify the agent has write access to the documentation repository.
- Check the workflow logs for error messages from the agent.

Expand All @@ -210,18 +201,9 @@

### Install the Mintlify app on your code repository

The Mintlify app must be installed on your code repository so the agent can fetch context from your codebase. To add the app to new repositories:

Check warning on line 204 in guides/automate-agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/automate-agent.mdx#L204

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

1. Open the agent panel in your Mintlify dashboard.
<Frame>
<img src="/images/agent/dashboard-light.png" alt="The agent panel in light mode." className="block dark:hidden" />
<img src="/images/agent/dashboard-dark.png" alt="The agent panel in dark mode." className="hidden dark:block" />
</Frame>
1. Click the **Settings** button.
<Frame>
<img src="/images/agent/dashboard-settings-light.png" alt="The settings button in light mode." className="block dark:hidden" />
<img src="/images/agent/dashboard-settings-dark.png" alt="The settings button in dark mode." className="hidden dark:block" />
</Frame>
1. Go to the [Agent](https://dashboard.mintlify.com/products/agent) page in your dashboard.
1. Click **Add to New Organization**. This takes you to the app installation page on GitHub.
1. Select the repositories you want to grant access to from the list.
1. Save your changes.
Expand Down Expand Up @@ -271,13 +253,13 @@

1. Navigate to your code repository on GitHub.
2. Click **Settings**.
3. Click **Webhooks**.

Check warning on line 256 in guides/automate-agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/automate-agent.mdx#L256

Use 'webhooks?' instead of 'Webhooks'.
4. Click **Add webhook**.
5. Configure the webhook:
- Payload URL: Paste your n8n webhook URL
- Content type: `application/json`
- Which events would you like to trigger this webhook?
- Select **Let me select individual events.**

Check warning on line 262 in guides/automate-agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/automate-agent.mdx#L262

Avoid first-person pronouns such as 'me'.
- Select only **Push events**.
- Select **Active**
6. Click **Add webhook**.
Expand Down Expand Up @@ -398,13 +380,13 @@
### The webhook is not triggering

- Verify the workflow is active in n8n.
- Check GitHub repository Settings → Webhooks → Recent Deliveries for the response code.

Check warning on line 383 in guides/automate-agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/automate-agent.mdx#L383

Use 'webhooks?' instead of 'Webhooks'.
- Confirm the webhook URL matches your n8n webhook URL exactly.

### 401 error from agent API

- Verify your API key starts with `mint_`.
- Check the Authorization header is formatted as `Bearer mint_yourkey`.

Check warning on line 389 in guides/automate-agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/automate-agent.mdx#L389

In general, use active voice instead of passive voice ('is formatted').
- Confirm the API key is for the correct Mintlify organization.

### 401 error from GitHub
Expand Down
Binary file removed images/agent/dashboard-settings-dark.png
Binary file not shown.
Binary file removed images/agent/dashboard-settings-light.png
Binary file not shown.
Binary file added images/agent/install-apps-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/agent/install-apps-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading