mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify-development[bot]
64 lines
3.5 KiB
Plaintext
64 lines
3.5 KiB
Plaintext
---
|
|
title: "Connect Linear"
|
|
description: "Trigger documentation updates from Linear issues and keep your docs in sync with your product roadmap."
|
|
keywords: ["Linear integration", "issue tracking", "agent integration", "project management", "automation"]
|
|
---
|
|
|
|
<Info>
|
|
The Linear integration is available on [Pro and Enterprise plans](https://mintlify.com/pricing?ref=agent).
|
|
</Info>
|
|
|
|
Connect Linear to the agent so your team can trigger documentation updates directly from issues and projects. When you link a Linear issue to the agent, it reads the issue context and creates a pull request with the relevant documentation 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 prompts to authorize Mintlify in your Linear workspace.
|
|
5. Select the teams and projects you want the agent to access.
|
|
|
|
## Use the agent with Linear
|
|
|
|
Once connected, the agent can receive tasks from Linear issues. You can trigger documentation updates by mentioning the agent in an issue comment or by using a workflow automation.
|
|
|
|
### Mention the agent in an issue
|
|
|
|
Add a comment on any Linear issue that mentions the agent with instructions on what documentation to create or update. The agent reads the issue title, description, and comment thread for context and opens a pull request with the changes.
|
|
|
|
For example, comment on an issue: `@mintlify Update the API docs to reflect the new authentication flow described in this issue`.
|
|
|
|
### Automate with Linear workflows
|
|
|
|
Set up a Linear workflow automation to notify the agent when issues move to a specific state, such as **Done** or **Ready for docs**. This keeps your documentation in sync with your product development cycle without manual intervention.
|
|
|
|
To configure a workflow automation:
|
|
|
|
1. In Linear, open your team's **Settings**.
|
|
2. Navigate to **Workflow automations**.
|
|
3. Create a new automation that triggers when an issue moves to your chosen state.
|
|
4. Set the action to notify the Mintlify integration.
|
|
|
|
{/* TODO: Verify exact Linear workflow automation UI steps once integration is live */}
|
|
|
|
### Link issues to documentation PRs
|
|
|
|
When the agent creates a pull request from a Linear issue, it includes a reference to the original issue. This creates a two-way link so your team can trace documentation changes back to the feature or bug that prompted them.
|
|
|
|
## What the agent uses as context
|
|
|
|
When triggered from a Linear issue, the agent reads:
|
|
|
|
- **Issue title and description** for an overview of the feature or change.
|
|
- **Comments and threads** for additional context and instructions.
|
|
- **Labels and project information** to understand the scope and category of the change.
|
|
- **Linked issues and related content** for broader context about the feature area.
|
|
- **Connected repositories** configured in your agent settings for code-level context.
|
|
|
|
## Best practices
|
|
|
|
- **Write clear issue descriptions**: The more context in the issue, the better the agent's documentation output.
|
|
- **Use a dedicated label**: Create a label like `docs` or `documentation` in Linear to tag issues that need documentation updates.
|
|
- **Review pull requests**: Always review the pull requests the agent creates before merging.
|
|
- **Combine with workflows**: Use Linear workflow automations to trigger documentation updates automatically when features ship, reducing manual handoffs between engineering and documentation teams.
|