diff --git a/agent/index.mdx b/agent/index.mdx index b6eba3d6f..85913306c 100644 --- a/agent/index.mdx +++ b/agent/index.mdx @@ -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. @@ -45,6 +45,9 @@ The agent can only access repositories that you connect through the Mintlify Git Add the agent to your Slack workspace. + +Add the agent to your Linear workspace. + Configure the agent with an `AGENTS.md` file. diff --git a/agent/linear.mdx b/agent/linear.mdx new file mode 100644 index 000000000..0f4a33d1f --- /dev/null +++ b/agent/linear.mdx @@ -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 + +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**. + + The App settings section with the Slack and Linear install buttonsi. + The App settings section with the Slack and Linear install buttons. + +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. diff --git a/agent/slack.mdx b/agent/slack.mdx index ea043fce5..228f08a9c 100644 --- a/agent/slack.mdx +++ b/agent/slack.mdx @@ -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. - - The settings button in light mode. - The settings button in dark mode. - -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**. + + The App settings section with the Slack and Linear install buttonsi. + The App settings section with the Slack and Linear install buttons. + +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 diff --git a/docs.json b/docs.json index 0d53e0a0d..272d69e7c 100644 --- a/docs.json +++ b/docs.json @@ -93,6 +93,7 @@ "root": "agent/index", "pages": [ "agent/slack", + "agent/linear", "agent/workflows", "agent/customize", "agent/effective-prompts", diff --git a/guides/automate-agent.mdx b/guides/automate-agent.mdx index 4b1502ffa..3800cee15 100644 --- a/guides/automate-agent.mdx +++ b/guides/automate-agent.mdx @@ -43,16 +43,7 @@ GitHub Actions is the simplest option if your code is already on GitHub. No addi 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: -1. Open the agent panel in your Mintlify dashboard. - - The agent panel in light mode. - The agent panel in dark mode. - -1. Click the **Settings** button. - - The settings button in light mode. - The settings button in dark mode. - +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. @@ -212,16 +203,7 @@ n8n provides a visual workflow editor and can integrate with multiple services. 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: -1. Open the agent panel in your Mintlify dashboard. - - The agent panel in light mode. - The agent panel in dark mode. - -1. Click the **Settings** button. - - The settings button in light mode. - The settings button in dark mode. - +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. diff --git a/images/agent/dashboard-settings-dark.png b/images/agent/dashboard-settings-dark.png deleted file mode 100644 index d24b8a2a7..000000000 Binary files a/images/agent/dashboard-settings-dark.png and /dev/null differ diff --git a/images/agent/dashboard-settings-light.png b/images/agent/dashboard-settings-light.png deleted file mode 100644 index 4ed47f999..000000000 Binary files a/images/agent/dashboard-settings-light.png and /dev/null differ diff --git a/images/agent/install-apps-dark.png b/images/agent/install-apps-dark.png new file mode 100644 index 000000000..d68605cac Binary files /dev/null and b/images/agent/install-apps-dark.png differ diff --git a/images/agent/install-apps-light.png b/images/agent/install-apps-light.png new file mode 100644 index 000000000..9742f56ce Binary files /dev/null and b/images/agent/install-apps-light.png differ