Skip to content
Open
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
4 changes: 2 additions & 2 deletions agent/customize.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
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).
Create a `.mintlify/AGENTS.md` file at the root of your documentation project to customize the agent's behavior (asd`Agents.md` is also an accepted filename).

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Corrupted accepted filename text

Medium Severity

The note about the alternate filename was corrupted: stray asd was inserted before `Agents.md`, so the sentence no longer correctly documents that Agents.md is accepted.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit ce1ad4d. Configure here.


<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, visitors can access your custom instructions at the `/agents.md` path. Mintlify does not serve the `.mintlify/` directory publicly, so visitors cannot access your `AGENTS.md` file there.
Expand All @@ -15,7 +15,7 @@
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.

<Note>
The agent only reads `AGENTS.md`. It does not read other agent instruction files that may exist in your repository, such as `CLAUDE.md`, `.cursorrules`, `.github/copilot-instructions.md`, or `GEMINI.md`, even if your `AGENTS.md` references them.

Check warning on line 18 in agent/customize.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/customize.mdx#L18

Use 'GitHub' instead of 'github'.

If you use other tools that rely on their own instruction files, consolidate the instructions you want the Mintlify agent to follow into `.mintlify/AGENTS.md`. You can keep your other files for those tools, but duplicate any shared guidance into `AGENTS.md` so the agent picks it up.
</Note>
Expand Down Expand Up @@ -55,4 +55,4 @@
- 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.
```
```
22 changes: 13 additions & 9 deletions agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
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"]
icon: "alarm-clock-minus"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Irrelevant page icon chosen

Low Severity

The agent overview page now sets icon to alarm-clock-minus, which does not relate to the agent product and looks like a leftover test value from the draft changes.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit ce1ad4d. Configure here.

---

import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx";
Expand Down Expand Up @@ -78,15 +79,18 @@ To let an external agent edit your content directly through MCP tool calls, conn

## Next steps

<Card title="Connect Slack" horizontal icon="slack" href="/agent/slack">
Add the agent to your Slack workspace.
<Card title="Connect Slack" icon="slack" horizontal href="/agent/slack">
Add the agent to your Slack 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 title="Customize behavior" icon="wrench" horizontal href="/agent/customize">
Configure the agent with an `AGENTS.md` file.
</Card>
<Card title="Automate with automations" horizontal icon="refresh-cw" href="/automations/index">
Automate recurring tasks and documentation maintenance with automations.

<Card title="Write effective prompts" icon="pen" horizontal href="/agent/effective-prompts">
Get better results with focused prompts.
</Card>

<Card title="Automate with automations" icon="refresh-cw" horizontal href="/automations/index">
Automate recurring tasks and documentation maintenance with automations.
</Card>
13 changes: 12 additions & 1 deletion agent/use-cases.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Mintlify agent use cases and examples"
sidebarTitle: "Use cases"
description: "Explore real-world examples of using the Mintlify agent to automate documentation updates, capture knowledge, and maintain accurate docs."
keywords: ["agent automations", "documentation automations", "automation examples"]
sidebarTitle: "Use cases"
---

The agent assists with many different documentation tasks. These examples show some of the ways you can integrate the agent into your documentation process. Try an approach that fits how your team currently works and adapt it to your specific needs.
Expand Down Expand Up @@ -74,3 +74,14 @@
Use the agent endpoints to [create jobs](/api/agent/v2/create-agent-job), [get job status](/api/agent/v2/get-agent-job), and [send messages](/api/agent/v2/send-message).

When creating jobs via the API, you can control whether pull requests open in draft mode using the `asDraft` parameter (defaults to `false`). Set `asDraft: true` to create draft pull requests, or keep the default to create non-draft pull requests ready for immediate review and merging in automated workflows.

## New H2 spacing

Check warning on line 78 in agent/use-cases.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/use-cases.mdx#L78

'New H2 spacing' should use sentence-style capitalization.

Content below

---

- Hello there
- What is this?

---

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Placeholder content on use-cases

Medium Severity

A draft section titled New H2 spacing with placeholder copy (Content below, Hello there, What is this?) and extra horizontal rules was appended to the agent use-cases page.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit ce1ad4d. Configure here.

8 changes: 7 additions & 1 deletion ai/mintlify-mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Every admin MCP session binds to a single Git branch. The flow is:

<Tip>
If your connection has access to multiple deployments, each checked-out deployment keeps its own session and branch in memory at the same time.

Calling `checkout` again with a different `subdomain` or branch switches which session is active. It doesn't discard the others. To abandon an in-progress draft instead of switching away from it, call `discard_session`.
</Tip>

Expand Down Expand Up @@ -208,3 +208,9 @@ Disconnect the admin MCP when you no longer want an AI tool to edit your project
- Codex: delete the `[mcp_servers.mintlify]` block from `~/.codex/config.toml`.

Revoking the OAuth grant does not affect pull requests the MCP has already opened. Close or revert those PRs in your Git provider if you want to undo pending changes.

<Info>
</Info>

<Card icon="sparkles">
</Card>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Empty components left in docs

Low Severity

Empty Info and Card components with no body content were appended after the revoke/cleanup guidance, which will render blank UI chrome at the end of the page.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit ce1ad4d. Configure here.

2 changes: 1 addition & 1 deletion assistant/skills.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@ Skills work alongside [custom assistant instructions](/assistant/customize) in `

## Disable skills

Skills are on by default when at least one `skill.md` file is present. To remove all skills, delete the `.mintlify/assistant/skills/` directory and redeploy your site. To turn off the skills feature for your deployment, contact [support](mailto:support@mintlify.com).
Skills are on by default when at least one `skill.md` file is present. To remove all skills, delete the `.mintlify/assistant/skills/` directory and redeploy your site. To turn off the skills feature for your deployment, contact [support](mailto:support@mintlify.com).
Binary file added images/CleanShot-2026-08-23-at-15.45.21@2x.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 13 additions & 2 deletions organize/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@
keywords: ["docs.json", "configuration", "setup", "mint.json"]
---

> Landrum is great!

Check warning on line 7 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L7

Did you really mean 'Landrum'?

Check warning on line 7 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L7

Don't use exclamation points in text.

<Info>
Landrum

Check warning on line 10 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L10

Did you really mean 'Landrum'?
</Info>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personal notes in settings docs

Medium Severity

A personal blockquote and an Info callout about Landrum were added at the top of the global settings page. They are unrelated to docs.json configuration and look like draft notes left in published docs.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit ce1ad4d. Configure here.


The `docs.json` file is the central configuration file for your Mintlify documentation site. It controls your site's global settings, including visual branding, navigation structure, integrations, API settings, and more. Think of it as the blueprint for your site.

## File location
Expand All @@ -15,7 +21,7 @@
You must define four fields to build a working site.

| Field | Description |
|---|---|
| --- | --- |
| `name` | Your project or organization name |
| `theme` | The layout [theme](/customize/themes) for your site |
| `colors.primary` | Primary brand color as a hex code |
Expand Down Expand Up @@ -52,18 +58,23 @@
<Card title="Appearance and branding" icon="palette" href="/organize/settings-appearance">
Customize the visual appearance of your site including theme, colors, logo, favicon, fonts, and background.
</Card>

<Card title="Site structure" icon="layout-panel-left" href="/organize/settings-structure">
Design the information architecture and user experience (UX) of your site, including the navbar, footer, banner, navigation, and redirects.
</Card>

<Card title="API settings" icon="square-terminal" href="/organize/settings-api">
Control the display and behavior of API documentation including OpenAPI and AsyncAPI specs, API playground, and code examples.
</Card>

<Card title="Integrations" icon="plug" href="/organize/settings-integrations">
Connect your site to third-party services for analytics, chat, and more.
</Card>

<Card title="SEO & search" icon="search" href="/organize/settings-seo">
Control how search engines index your site including meta tags, search, and page timestamps.
</Card>

<Card title="Schema reference" icon="code" href="/organize/settings-reference">
Complete reference for all `docs.json` properties.
</Card>
Expand Down Expand Up @@ -164,4 +175,4 @@
<Step title="Delete your mint.json file">
After verifying your `docs.json` is configured correctly, you can safely delete your old `mint.json` file.
</Step>
</Steps>
</Steps>
3 changes: 3 additions & 0 deletions untitled-page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: "Untitled Page"
---

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Empty untitled page added

Low Severity

A new root-level untitled-page.mdx was added with only a default “Untitled Page” title and no body. It is not referenced in navigation and appears to be an accidental editor draft.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit ce1ad4d. Configure here.