Skip to content
Closed
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
410 changes: 410 additions & 0 deletions de.json

Large diffs are not rendered by default.

634 changes: 634 additions & 0 deletions de/admin-openapi.json

Large diffs are not rendered by default.

99 changes: 99 additions & 0 deletions de/advanced-support.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
---
title: "Advanced support"
description: "Get premium support with faster response times, a dedicated customer success manager, and priority assistance for your documentation site."
keywords: ["support", "CSM", "enterprise"]
---

## Support options

- All customers receive support via dashboard or support@mintlify.com (24 hour response)
- Enterprise plan customers can add Advanced Slack support (24-hour response) or a dedicated CSM (4-hour response + strategic partnership)

### Standard support (included)

Included with all Pro and Enterprise plans. Submit tickets through the dashboard or email support@mintlify.com. First response within 24-48 hours.

### Advanced Slack support (add-on)

Get a dedicated Slack channel with our support team for faster troubleshooting.

**What you get:**
- Slack channel for your team and Mintlify support engineers
- 24-hour first response SLA
- Expedited bug escalation to the Mintlify engineering team

**Best for:** Teams that need faster response times but don't require strategic partnership or scheduled check-ins.

### Dedicated CSM (add-on)

Get an assigned Customer Success Manager who knows your team, setup, and goals.

**What you get:**
- Assigned CSM as your primary contact
- 4-hour first response SLA (9 AM-5 PM PST for US customers, 24 hours international)
- Dedicated Slack channel
- Monthly check-ins
- Quarterly business reviews
- Shared feature request tracker with direct product team escalation
- Priority bug and incident escalation

**Best for:** Teams that need fast responses, proactive guidance, and influence over the product roadmap.

## FAQ

### Dedicated CSM

<AccordionGroup>
<Accordion title="What's the difference between a dedicated CSM and standard support?">
We deliver standard support via the dashboard or support@mintlify.com with a 24-48 hour response SLA. A Dedicated CSM includes both a primary point of contact and a dedicated Slack channel. The main differences are:

- **Response time:** 4 hours for US customers during business hours versus 24-48 hours for standard support
- **Relationship:** One person who knows your setup versus a support team rotation
- **Proactive engagement:** Monthly check-ins and QBRs versus reactive support
- **Product influence:** Direct escalation to the product team and input on the roadmap
- **Strategic planning:** Quarterly business reviews and success planning
</Accordion>

<Accordion title="Why is a dedicated CSM priced at a premium?">
You're getting a person who knows your team, your setup, and your goals—not a support queue. This includes:

- 4-hour response SLA (versus 24-48 hours for standard support)
- Monthly check-ins and quarterly business reviews
- Direct influence on what we build
- Priority escalation for bugs and incidents
- Curated feature updates and enablement materials

This is premium, high-touch service calibrated for teams where fast resolution and strategic partnership matter. If you want faster support without the full CSM relationship, our advanced Slack support option gives you a dedicated channel with 24-hour response times at a lower price point.
</Accordion>

<Accordion title="How does feature request tracking work?">
Every dedicated CSM customer gets a shared Google Sheet tracker where you can:

- Submit feature requests with context and priority
- See status updates as requests move through review and development
- Track which features have been shipped
- Provide feedback and additional details as features are scoped

Your CSM reviews this tracker regularly and escalates priority items directly to our product team.
</Accordion>
</AccordionGroup>

### Advanced Slack support

<AccordionGroup>
<Accordion title="What's the difference between advanced Slack support and standard support?">
We deliver standard support (included with Pro and Enterprise plans) via the dashboard or support@mintlify.com with a 24-48 hour response SLA. Advanced Slack support includes:

- Dedicated Slack channel versus email/dashboard support
- 24-hour response SLA versus 24-48 hours for standard support
- Expedited bug escalation to the Mintlify engineering team
</Accordion>

<Accordion title="Why is advanced Slack support priced separately?">
You're getting a dedicated Slack channel with our support team plus expedited engineering escalation for bugs and incidents—not email support with 24-48 hour response times. This is premium support for teams that need faster answers without the full strategic CSM relationship.
</Accordion>
</AccordionGroup>

## Get started

Contact your Mintlify account team to add advanced Slack support or a dedicated CSM, or email gtm@mintlify.com.
52 changes: 52 additions & 0 deletions de/agent/customize.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: "Customize agent behavior"
description: "Customize agent behavior with an `AGENTS.md` configuration file to control how the agent handles documentation tasks and follows your conventions."
keywords: ["AGENTS.md", "agent configuration", "custom instructions", "agent customization"]
---

Create a `.mintlify/AGENTS.md` file at the root of your documentation project to customize the agent's behavior (`Agents.md` is also an accepted filename).

<Warning>
Place your `AGENTS.md` file inside the `.mintlify/` directory, not at the root of your project. If you store the file at the root of your project, your custom instructions are publicly accessible by the `/agents.md` path. The `.mintlify/` directory is not served publicly so your `AGENTS.md` file is not accessible when in that directory.

If you must store your `AGENTS.md` file at the root of your project or any other directory, add it to your [`.mintignore`](/organize/mintignore) file to exclude it from your documentation site.
</Warning>

Add any instructions that you want the agent to follow. The agent appends these instructions to its system prompt, so the instructions apply to all tasks whether you use the agent in your dashboard, on Slack, or via the API.

## What to include in AGENTS.md

Consider adding instructions for:

- **Style preferences**: Voice, tone, formatting, and terminology specific to your documentation.
- **Code standards**: Programming languages, frameworks, and coding conventions to use in examples.
- **Content requirements**: What sections or information to include for different types of pages.
- **Project context**: Specific details about your product, architecture, or user base that inform documentation decisions.

## Example AGENTS.md file

```markdown .mintlify/AGENTS.md
# Documentation agent instructions

## Code examples
- Use TypeScript for all code examples. Our users are primarily TypeScript developers.
- Always include error handling in API call examples.
- Show both success and error response examples for all endpoints.
- Include import statements at the top of code examples.

## API documentation standards
- Every endpoint must document: authentication requirements, rate limits, and common error codes.
- Use real-world parameter values in examples (not foo/bar placeholders).
- Include a complete request/response cycle for each endpoint.

## Style and formatting
- Write for developers with 2-5 years of experience. Don't oversimplify, but explain non-obvious concepts.
- Use active voice and second person ("you").
- Date format: ISO 8601 (YYYY-MM-DD).
- When referencing UI elements, use bold: **Settings** button.

## What to include
- Add prerequisite sections to guides when users need API keys, environment setup, or dependencies.
- Include "Next steps" sections linking to related documentation.
- Add troubleshooting sections for common issues we see in support tickets.
```
34 changes: 34 additions & 0 deletions de/agent/effective-prompts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: "Write effective prompts"
description: "Write clear, specific prompts to get better results from the Mintlify agent, with examples of effective instructions and tips for common patterns."
keywords: ["prompts", "agent prompts", "effective prompting", "agent usage"]
---

Think of the agent as a helpful assistant that needs your guidance to complete tasks. Give it clear instructions and context. More focused tasks are easier to complete, so break down complex projects into smaller steps.

## Make prompts specific and outcome-focused

Generic prompts like `@mintlify Improve the onboarding page` apply general best practices, but may not improve content in the specific way that you were picturing.

Try prompts based on outcomes you want your users to achieve or problems that they encounter.

- `@mintlify A lot of users have trouble installing the CLI. Review the onboarding page and update the docs so that users can easily install the CLI`
- `@mintlify Developers keep getting 401 errors when following our authentication guide. Review the auth docs and add clearer examples showing how to properly format the API key`

## Use broad prompts for maintenance tasks

Use broad prompts for general content maintenance like fixing typos, updating redirects, or renaming a feature throughout your docs.

- `@mintlify Find and fix all typos in the docs`
- `@mintlify change all unordered lists to use * instead of -`

## Specify a domain name for multi-site organizations

If you have multiple documentation sites, include the `subdomain` parameter in your message to specify which documentation set the agent should work on.

To find your domain name, look at your dashboard URL for the documentation set you want to update. The domain name is the last part after your organization name. For example, if your dashboard URL is `https://dashboard.mintlify.com/org-name/domain-name`, your domain name is `domain-name`.

Use the format `@mintlify subdomain=<your-domain-name> <your-prompt>` to prompt the agent to work on a specific documentation set.

- `@mintlify subdomain=public-docs Add a new section to the quickstart about inviting collaborators based on this PR`: Prompts the agent to update the quickstart only on the `public-docs` site.
- `@mintlify subdomain=customer-docs Update the auth docs for the new authentication method`: Prompts the agent to update the auth docs only on the `customer-docs` site.
70 changes: 70 additions & 0 deletions de/agent/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: "What is the agent?"
description: "Learn how the Mintlify agent researches, plans, and writes documentation, then opens pull requests with proposed changes for your team to review."
keywords: ["automation", "automate", "AI", "autoupdate", "maintenance"]
---

import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx";

<Info>
The agent is available on [Pro and Enterprise plans](https://mintlify.com/pricing?ref=agent).
</Info>

The agent is an AI tool that creates pull requests with proposed changes to your documentation based on your prompts. When you send a request, the agent:

- **Researches**: Searches and reads your existing documentation, any connected repositories, relevant context, and the web.
- **Plans**: Creates a structured task list for complex documentation work.
- **Writes**: Generates or updates content following writing standards and best practices.
- **Validates**: Runs Mintlify CLI checks to ensure documentation builds correctly.
- **Creates a PR**: Opens a pull request with proposed changes for review.

All changes go through pull requests. The agent never commits directly to your main branch.

## What you can do with the agent

Use the agent to:

- Write new content based on your prompts, pull requests, 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.
- Reference source code from any repository that has the Mintlify GitHub App installed.
- Automate documentation maintenance with workflows.
- Answer questions about your docs and technical writing topics.
- Address code review feedback to maintain documentation quality.
- Capture knowledge from Slack conversations and pull requests before it gets lost.
- Navigate and coordinate changes across multiple files and directories efficiently.

## Connect your GitHub account

By default, the agent opens pull requests attributed to the Mintlify bot. To attribute pull requests to you, connect your GitHub account on the [My profile](https://dashboard.mintlify.com/settings/account) page of the dashboard.

## Connect repositories as context

The agent can only access repositories that you connect through the Mintlify GitHub App. Configure which repositories the agent can access in the agent panel **Settings** or in the [GitHub App settings](https://github.com/apps/mintlify/installations/new).

## Use AI tools alongside the agent

The agent works asynchronously through pull requests, but you can also use AI coding tools like Cursor or Claude Code locally for fast, iterative edits. Install the Mintlify [skill](/ai/skillmd) and connect the [MCP server](/ai/model-context-protocol) so your editor has the same context the agent uses.

To let an external agent edit your content directly through MCP tool calls, connect it to the [Mintlify MCP server](/ai/mintlify-mcp).

<SkillMcpPrompt />

## Next steps

<Card title="Connect Slack" horizontal icon="slack" href="/agent/slack">
Add the agent to your Slack workspace.
</Card>
<Card title="Connect Notion" horizontal icon="notion" 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>
<Card title="Write effective prompts" horizontal icon="pen" href="/agent/effective-prompts">
Get better results with focused prompts.
</Card>
<Card title="Automate with workflows" horizontal icon="refresh-cw" href="/workflows/index">
Automate recurring tasks and documentation maintenance with workflows.
</Card>
42 changes: 42 additions & 0 deletions de/agent/notion.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: "Connect Notion to the agent"
description: "Connect Notion to the Mintlify agent so it can reference your workspace pages and databases as context when creating documentation updates."
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

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 and Notion install buttons." className="block dark:hidden" />
<img src="/images/agent/install-apps-dark.png" alt="The App settings section with the Slack 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.
Loading
Loading