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
3 changes: 3 additions & 0 deletions agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ Add the agent to your Slack workspace.
<Card title="Connect Linear" horizontal icon="linear" href="/agent/linear">
Add the agent to your Linear workspace.
</Card>
<Card title="Connect Notion" horizontal icon="file-lines" href="/agent/notion">
Give the agent access to your Notion workspace.
</Card>
<Card title="Customize behavior" horizontal icon="wrench" href="/agent/customize">
Configure the agent with an `AGENTS.md` file.
</Card>
Expand Down
4 changes: 2 additions & 2 deletions agent/linear.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Connect your Linear workspace to the agent to make documentation updates from Li
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" />
<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.

Expand Down
42 changes: 42 additions & 0 deletions agent/notion.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: "Connect Notion to the agent"
description: "Give the agent access to your Notion workspace to reference pages and databases when updating documentation."
keywords: ["Notion", "integration", "knowledge base", "context"]
---

Connect your Notion workspace to the agent so that it can search your Notion content and use it as context when creating documentation updates. The additional context from your team's knowledge base, product specs, and internal documentation stored in Notion helps the agent create more accurate and complete documentation.

## Connect your Notion workspace

Check warning on line 9 in agent/notion.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/notion.mdx#L9

'Connect your Notion 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 Notion 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 prompts to authorize Mintlify to access your Notion workspace.
4. In Notion's authorization screen, select which pages and databases to share with Mintlify.

## What the agent can do with Notion

The Notion integration uses Notion's [MCP tools](https://developers.notion.com/guides/mcp/mcp-supported-tools#mcp-tools) to search and read your workspace content.

Your content in Notion becomes additional context for the agent to use when generating documentation.

When the agent has access to your Notion workspace, it can:

- **Search Notion**: Find relevant pages and databases in your connected Notion workspace based on the context of your request.
- **Read Notion pages**: Access the content of Notion pages to use as reference material when generating documentation.
- **Reference databases**: Pull structured data from Notion databases to inform documentation updates.

## Use cases

- **Sync product specs to docs**: Reference product requirement documents and design specs stored in Notion when writing feature documentation.
- **Document from meeting notes**: Point the agent to meeting notes or decision logs in Notion to draft documentation based on team discussions.
- **Pull from internal knowledge bases**: Use internal wikis and knowledge bases in Notion as source material for public-facing documentation.

## Best practices

- **Scope access carefully**: Only grant access to the Notion pages and databases that contain information relevant to your documentation.
- **Provide specific references**: When prompting the agent, mention the specific Notion page or database you want it to reference for best results.
- **Review generated content**: Always review pull requests to ensure information from Notion is appropriately adapted for your public documentation.
4 changes: 2 additions & 2 deletions agent/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ keywords: ["Slack integration", "Slack bot", "team collaboration", "agent integr
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" />
<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 Slack prompts to install the `mintlify` app in your workspace.
4. Follow the Slack prompts to link your Mintlify account to your Slack workspace.
Expand Down
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@
"pages": [
"agent/slack",
"agent/linear",
"agent/notion",
"agent/workflows",
"agent/customize",
"agent/effective-prompts",
Expand Down
Binary file modified 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 modified 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