mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
49 lines
2.6 KiB
Plaintext
49 lines
2.6 KiB
Plaintext
---
|
|
title: "Connect Linear"
|
|
description: "Use the agent with Linear to automatically update documentation when issues are created or changed."
|
|
keywords: ["Linear integration", "project management", "issue tracking", "agent integration", "automation"]
|
|
---
|
|
|
|
<Info>
|
|
The Linear integration is available on [Pro and Enterprise plans](https://mintlify.com/pricing?ref=agent).
|
|
</Info>
|
|
|
|
Connect Linear to the Mintlify agent to turn Linear issues into documentation updates. When you create or update an issue that involves documentation, the agent picks it up, follows the instructions, and opens a pull request with the changes.
|
|
|
|
## Connect your Linear workspace
|
|
|
|
1. Open the agent panel in your [dashboard](https://dashboard.mintlify.com/products/agent).
|
|
2. Click the **Settings** button.
|
|
3. In the Linear integration section, click **Connect**.
|
|
4. Follow the Linear prompts to authorize the Mintlify app in your workspace.
|
|
|
|
## How it works
|
|
|
|
Once connected, the agent monitors your Linear workspace for issues assigned to it. When the agent receives an issue:
|
|
|
|
1. It reads the issue title, description, and any linked context.
|
|
2. It clones your documentation repository and any connected context repositories.
|
|
3. It follows the instructions in the issue to make documentation changes.
|
|
4. It opens a pull request with the proposed updates.
|
|
|
|
The agent comments on the Linear issue with a link to the pull request so your team can track progress directly in Linear.
|
|
|
|
## Assign issues to the agent
|
|
|
|
Create a Linear issue with documentation instructions and assign it to **Mintlify**. The issue description acts as the prompt for the agent.
|
|
|
|
Write your issue descriptions the same way you would write a prompt for the agent in Slack or the dashboard. Be specific about what you want updated and where.
|
|
|
|
**Example issue:**
|
|
|
|
> **Title:** Update authentication docs for OAuth 2.0 support
|
|
>
|
|
> **Description:** We added OAuth 2.0 support in the latest release. Update the authentication page to include the new OAuth flow, configuration options, and a code example showing how to set it up.
|
|
|
|
## Best practices
|
|
|
|
- **Be specific in issue descriptions.** Include what to change, where to change it, and any relevant context. Vague issues produce vague results.
|
|
- **Link related pull requests.** If the documentation update relates to a code change, include the PR link in the issue description so the agent has full context.
|
|
- **Review pull requests before merging.** The agent opens PRs for review. Always check the proposed changes before merging them into your documentation.
|
|
- **Use labels to organize.** Create a `docs` or `documentation` label in Linear to keep agent-related issues easy to find and filter.
|