mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
d6960c72bf
* Improve SEO metadata: fix titles, descriptions, and remove redundant OpenAPI descriptions - Remove description frontmatter from 19 API pages where the OpenAPI spec already supplies the description - Fix 2 titles that exceeded 60 characters (content-templates, content-types) - Improve 15 descriptions that were too short (<130 chars) or too long (>160 chars) to target 130-155 characters - All descriptions are unique and include relevant search terms Generated-By: mintlify-agent * re-add API descriptions * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
35 lines
2.3 KiB
Plaintext
35 lines
2.3 KiB
Plaintext
---
|
|
title: "Add the agent to Linear"
|
|
description: "Connect the Mintlify agent to Linear so it can draft documentation updates from issues, comments, and project activity."
|
|
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**.
|
|
<Frame>
|
|
<img src="/images/agent/install-apps-light.png" alt="The App settings section with the Slack, Linear, and Notion install buttons." className="block dark:hidden" />
|
|
<img src="/images/agent/install-apps-dark.png" alt="The App settings section with the Slack, Linear, and Notion 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.
|