Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
33f4532
implement task-based IA
ethanpalm Sep 19, 2025
ba17048
rearrange pages
ethanpalm Sep 19, 2025
807061c
tag examples
ethanpalm Sep 19, 2025
31e8279
add cookbook example
ethanpalm Sep 23, 2025
80943b3
Merge branch 'main' into task-based-IA
ethanpalm Sep 24, 2025
59e4eda
add a components menu
ethanpalm Sep 25, 2025
77a8336
rename cookbook to guides
ethanpalm Sep 25, 2025
aee4ea7
Merge branch 'main' into task-based-IA
ethanpalm Sep 25, 2025
efb2973
fix docs.json after adding translations
ethanpalm Sep 25, 2025
024fe78
prettier docs.json
ethanpalm Sep 25, 2025
acd894f
move content to Guides
ethanpalm Sep 25, 2025
005907b
move GEO page to guides
ethanpalm Sep 25, 2025
0a1e861
draft of ai-native page
ethanpalm Sep 26, 2025
94081e9
update body with info on reading/distributing
ethanpalm Sep 26, 2025
271a217
copy edits
ethanpalm Sep 26, 2025
88e6f5f
💅
ethanpalm Sep 26, 2025
95c6017
move guides above API reference
ethanpalm Sep 26, 2025
536cb8a
remove CLI sidebarTitle
ethanpalm Sep 26, 2025
5136178
update organization
ethanpalm Sep 26, 2025
4a4a4a3
remove tags
ethanpalm Sep 26, 2025
1f4762c
remove guides icons
ethanpalm Sep 26, 2025
a079083
Merge branch 'main' into task-based-IA
ethanpalm Sep 26, 2025
954387e
Merge branch 'main' into task-based-IA
ethanpalm Sep 29, 2025
43ddc1b
Update ai-native.mdx
ethanpalm Sep 30, 2025
f9fdf49
Update ai-native.mdx
ethanpalm Sep 30, 2025
cb0cd89
copyedits
ethanpalm Sep 30, 2025
355c5cb
💅
ethanpalm Sep 30, 2025
33bd18d
even number of cards
ethanpalm Sep 30, 2025
450e9e2
update discovering section
ethanpalm Sep 30, 2025
ee50453
remove components tab
ethanpalm Sep 30, 2025
24520bb
remove icons
ethanpalm Sep 30, 2025
89112bf
remove icon
ethanpalm Sep 30, 2025
1ad2ce9
add group level icons
ethanpalm Sep 30, 2025
f4532f7
update Get started group
ethanpalm Sep 30, 2025
903573e
Update organize group
ethanpalm Sep 30, 2025
a2244d4
update customize group
ethanpalm Sep 30, 2025
87910f7
update create content group
ethanpalm Oct 1, 2025
2e42626
shorten URLs
ethanpalm Oct 1, 2025
384f3db
update API group
ethanpalm Oct 1, 2025
f0aafd0
update deploy group
ethanpalm Oct 1, 2025
daa31c7
update optimize and guides groups
ethanpalm Oct 1, 2025
5a08163
Merge branch 'main' into task-based-IA
ethanpalm Oct 1, 2025
4c568e4
set up redirects
ethanpalm Oct 1, 2025
b730132
Merge branch 'main' into task-based-IA
ethanpalm Oct 1, 2025
0635873
update links
ethanpalm Oct 1, 2025
015cf34
Merge branch 'main' into task-based-IA
ethanpalm Oct 1, 2025
865beaa
add pdf page
ethanpalm Oct 1, 2025
f7a4ea6
add missing icons
ethanpalm Oct 1, 2025
b2f631b
remove default expanded state
ethanpalm Oct 1, 2025
0ec3e82
update docs.json
ethanpalm Oct 1, 2025
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
47 changes: 47 additions & 0 deletions ai-native.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: "AI-native"
description: "Learn how AI enhances reading, writing, and discovering your documentation"
---

When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. Your content provides the context for these AI-native features to improve the experiences of reading, writing, and discovering your documentation.

## What makes your documentation AI-native

### Reading

In addition to reading individual pages, users can chat with the [assistant](/ai/assistant) in your documentation for immediate answers to their questions and links to relevant content. The assistant helps guide users through your product with accurate information from your documentation. Embed the assistant into custom apps with the [API](api-reference/assistant/create-assistant-message) to extend where users can access your documentation.

### Writing

The [agent](/ai/agent) helps you write and maintain documentation. It creates pull requests with proposed changes based on your prompts, pull requests, and Slack threads. Add the agent to your Slack workspace so that anyone on your team can help maintain your documentation by chatting with the agent. Or embed the agent into custom apps via the [API](/api-reference/agent/create-agent-job).

Configure popular tools like [Cursor](/guides/cursor), [Claude Code](/guides/claude-code), and [Windsurf](/guides/windsurf) to reference the Mintlify schema, your style guide, and best practices.

### Discovering

Your site is automatically optimized for AI tools and search engines to help users discover your documentation. All pages are sent as Markdown to AI agents instead of HTML, which helps these tools process your content faster and use fewer tokens. Every page is also available to view as Markdown by appending `.md` to the URL.

Check warning on line 22 in ai-native.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai-native.mdx#L22

In general, use active voice instead of passive voice ('are sent').

Mintlify hosts `llms.txt` and `llms-full.txt` files for your documentation. These industry-standard files help LLMs index your documentation and respond efficiently with relevant information to user queries.

Your documentation site also hosts an MCP server that lets users connect your documentation directly to their AI tools for up to date information about your product directly where they want it.

Full-text search and semantic understanding help users and AI tools find relevant information quickly. Search understands user intent rather than just matching keywords. And if a user encounters a 404 error, your site suggests related pages to help them find what they're looking for. No configuration required.

## Enable AI features

Select any of the following cards for more information.

<CardGroup cols={2}>
<Card title="Assistant" icon="bot-message-square" href="/ai/assistant">
Configure the assistant to search external sites or direct people to your support team if it can't answer their questions.
</Card>
<Card title="Agent" icon="pen-line" href="/ai/agent">
Add the agent to your Slack workspace or embed it into custom apps to have it help write and update your documentation.
</Card>
<Card title="Contextual menu" icon="sparkles" href="/ai/contextual-menu">
Add a menu to pages that lets users query AI tools, connect to your MCP server, and copy pages as context with one click.
</Card>
<Card title="MCP integration" icon="plug" href="/ai/model-context-protocol">
Your site has a hosted MCP server that lets users connect your documentation directly to their AI tools. Make your users aware of your MCP server and how to connect to it.
</Card>
</CardGroup>
1 change: 0 additions & 1 deletion ai/agent.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Agent"
description: "The agent helps you write and maintain documentation"
icon: "pen-line"
---

<Info>
Expand All @@ -22,7 +21,7 @@
## Add the agent to your Slack workspace

<Note>
If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the Mintlify app before you connect it.

Check warning on line 24 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L24

Use 'administrator' instead of 'admin'.
</Note>

1. Navigate to the [agent](https://dashboard.mintlify.com/products/agent) page of your dashboard.
Expand Down
3 changes: 1 addition & 2 deletions guides/assistant.mdx → ai/assistant.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Assistant"
description: "Help users succeed with your product and find answers faster"
icon: "bot"
---

<Info>
Expand All @@ -10,15 +9,15 @@

## About the assistant

The assistant answers questions about your documentation through natural language queries. It is embedded directly in your documentation site, providing users with immediate access to contextual help.

Check warning on line 12 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L12

Use 'it's' instead of 'It is'.

Check warning on line 12 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L12

In general, use active voice instead of passive voice ('is embedded').

The assistant uses agentic RAG (retrieval-augmented generation) with tool calling powered by Claude Sonnet 4. When users ask questions, the assistant:

Check warning on line 14 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L14

Spell out 'RAG', if it's unfamiliar to the audience.

Check warning on line 14 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L14

Use parentheses judiciously.

* **Searches and retrieves** relevant content from your documentation to provide accurate answers.
* **Cites sources** and provides navigable links to take users directly to referenced pages.
* **Generates copyable code examples** to help users implement solutions from your documentation.

Each message sent to the assistant counts toward your plan's message allowance. If you exceed your allowance, additional messages incur overage charges. You can set spending limits or disable the assistant if you reach your message allowance.

Check warning on line 20 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L20

Use 'turn off' or 'off' instead of 'disable'.

You can view assistant usage through your dashboard to understand user behavior and documentation effectiveness. Export and analyze query data to help identify:

Expand All @@ -28,15 +27,15 @@

## Configuring the assistant

The assistant is enabled by default for Pro and Custom plans. You can manage the assistant from your [dashboard](https://dashboard.mintlify.com/products/assistant/settings), including enabling or disabling it, configuring response handling, and setting a spend limit.

Check warning on line 30 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L30

In general, use active voice instead of passive voice ('is enabled').

### Assistant status

Toggle the assistant status to enable or disable the assistant for your documentation site.

Check warning on line 34 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L34

Use 'turn off' or 'off' instead of 'disable'.

### Assistant deflection

Enable the assistant to redirect unanswered questions to your support team. Provide an email address that the assistant will provide to users who ask questions that it cannot answer.

Check warning on line 38 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L38

Avoid using 'will'.

Check warning on line 38 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L38

Use 'can't' instead of 'cannot'.

### Search sites

Expand All @@ -47,7 +46,7 @@
Configure sites that the assistant can search for additional context when answering questions.

- Sites must be publicly available.
- Sites that require JavaScript to load are not supported.

Check warning on line 49 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L49

Use 'aren't' instead of 'are not'.

You can use the following filtering syntax when you configure external sites:

Expand All @@ -62,9 +61,9 @@

### Spend limit

Set a spend limit to control what happens if you reach your message allowance. By default, the assistant will continue to answer user questions after you reach your message allowance, which incurs overages.

Check warning on line 64 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L64

Avoid using 'will'.

In the **Billing** tab of the [Assistant Configurations](https://dashboard.mintlify.com/products/assistant/settings) page, you can set a spend limit for assistant messages beyond your allowance. When you reach your spend limit, the assistant is disabled until your message allowance resets.

Check warning on line 66 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L66

In general, use active voice instead of passive voice ('is disabled').

Check warning on line 66 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L66

Use 'turn off' or 'off' instead of 'disabled'.

You can also set usage alerts to receive an email when you reach a certain percentage of your spend limit.

Expand All @@ -72,7 +71,7 @@

Users can access the assistant in three ways:

- **Keyboard shortcut**: <kbd>Command</kbd> + <kbd>I</kbd> (<kbd>Ctrl</kbd> + <kbd>I</kbd> on Windows)

Check warning on line 74 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L74

Avoid first-person pronouns such as ' I '.
- **Assistant button** next to the search bar
<img
src="/images/assistant/assistant-button-light.png"
Expand All @@ -92,9 +91,9 @@
}}
alt="Search bar and assistant button in dark mode."
/>
- **URLs** with `?assistant=open` appended will open the assistant when the page loads. For example, [https://mintlify.com/docs?assistant=open](https://mintlify.com/docs?assistant=open).

Check warning on line 94 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L94

Avoid using 'will'.

Both methods open a chat panel on the right side of your docs. Users can ask any question and the assistant will search your documentation for an answer. If no relevant information is found, the assistant will respond that it cannot answer the question.

Check warning on line 96 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L96

Avoid using 'will'.

Check warning on line 96 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L96

In general, use active voice instead of passive voice ('is found').

Check warning on line 96 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L96

Avoid using 'will'.

Check warning on line 96 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L96

Use 'can't' instead of 'cannot'.

## Making content AI ingestible

Expand All @@ -114,7 +113,7 @@
- Provide sufficient conceptual content about features and procedures.
- Include examples and use cases.
- Cross-reference related topics.
- Add [hidden pages](/guides/hidden-pages) with additional context that users don't need, but the assistant can reference.
- Add [hidden pages](/organize/hidden-pages) with additional context that users don't need, but the assistant can reference.
</Card>

## Exporting and analyzing queries
Expand All @@ -125,7 +124,7 @@
- Discover user behavior patterns and common information needs from themes and patterns in queries.
- Prioritize high-traffic pages for accuracy and quality improvements.

You can explore queries from your [dashboard](https://dashboard.mintlify.com/products/assistant), but to get more powerful insights we recommend exporting a `CSV` file of your queries, responses, and sources to analyze with your preferred AI tool.

Check warning on line 127 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L127

Try to avoid using first-person plural like 'we'.

1. Navigate to the [assistant page](https://dashboard.mintlify.com/products/assistant) in your dashboard.
2. Select **Export to CSV**.
Expand Down
1 change: 0 additions & 1 deletion ai/contextual-menu.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Contextual menu"
description: "Add one-click AI integrations to your docs"
icon: "square-menu"
---

import { PreviewButton } from "/snippets/previewbutton.jsx"
Expand Down
1 change: 0 additions & 1 deletion ai/llmstxt.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "llms.txt"
description: "Make your content easier for LLMs to read and index"
icon: "file-code"
---

import { PreviewButton } from "/snippets/previewbutton.jsx"
Expand All @@ -14,7 +13,7 @@

<PreviewButton href="https://mintlify.com/docs/llms.txt">Open the llms.txt for this site.</PreviewButton>

## llms.txt structure

Check warning on line 16 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L16

'llms.txt structure' should use sentence-style capitalization.

An `llms.txt` file is a plain Markdown file that contains:

Expand All @@ -34,9 +33,9 @@

This structured approach allows LLMs to efficiently process your documentation at a high level and locate relevant content for user queries, improving the accuracy and speed of AI-assisted documentation searches.

## llms-full.txt

Check warning on line 36 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L36

'llms-full.txt' should use sentence-style capitalization.

The `llms-full.txt` file combines your entire documentation site into a single file as context for AI tools and is indexed by LLM traffic.

Check warning on line 38 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L38

In general, use active voice instead of passive voice ('is indexed').

Check warning on line 38 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L38

Spell out 'LLM', if it's unfamiliar to the audience.

Mintlify automatically hosts an `llms-full.txt` file at the root of your project. View your `llms-full.txt` by appending `/llms-full.txt` to your documentation site's URL.

Expand All @@ -44,6 +43,6 @@

## Custom files

To add a custom `llms.txt` or `llms-full.txt` file, create an `llms.txt` or `llms-full.txt` file at the root of your project. Adding a custom file will override the automatically generated file of the same name. If you delete a custom file, the default file will be used again.

Check warning on line 46 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L46

Avoid using 'will'.

Check warning on line 46 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L46

Avoid using 'will'.

Check warning on line 46 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L46

In general, use active voice instead of passive voice ('be used').

Your custom `llms.txt` or `llms-full.txt` file must have a site title as an H1 heading. Other content is optional. See [Format](https://llmstxt.org/#format) in the `llms.txt` specification for more information on optional sections and best practices.
1 change: 0 additions & 1 deletion ai/markdown-export.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
---
title: "Markdown export"
description: "Quickly get Markdown versions of pages"
icon: "file-text"
---

import { PreviewButton } from "/snippets/previewbutton.jsx"

Markdown provides structured text that AI tools can process more efficiently than HTML, which results in better response accuracy, faster processing times, and lower token usage.

Mintlify automatically generates Markdown versions of pages that are optimized for AI tools and external integrations.

Check warning on line 10 in ai/markdown-export.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/markdown-export.mdx#L10

In general, use active voice instead of passive voice ('are optimized').

## .md URL extension

Check warning on line 12 in ai/markdown-export.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/markdown-export.mdx#L12

'.md URL extension' should use sentence-style capitalization.

Add `.md` to any page's URL to view a Markdown version.

Expand Down
1 change: 0 additions & 1 deletion ai/model-context-protocol.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Model Context Protocol"
description: "Let users access your docs and APIs through their favorite AI tools"
icon: "audio-waveform"
keywords: ["mcp"]
---

Expand All @@ -16,14 +15,14 @@
## Accessing your MCP server

<Note>
MCP servers can only be generated for public documentation. Documentation behind end-user authentication cannot be accessed for server generation.

Check warning on line 18 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L18

In general, use active voice instead of passive voice ('be generated').

Check warning on line 18 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L18

Use 'can't' instead of 'cannot'.

Check warning on line 18 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L18

In general, use active voice instead of passive voice ('be accessed').
</Note>

Mintlify automatically generates an MCP server for your documentation and hosts it at your documentation URL with the `/mcp` path. For example, Mintlify's MCP server is available at `https://mintlify.com/docs/mcp`.

You can see and copy your MCP server URL in your [dashboard](https://dashboard.mintlify.com/products/mcp).

The `/mcp` path is reserved for hosted MCP servers and cannot be used for other navigation elements.

Check warning on line 25 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L25

In general, use active voice instead of passive voice ('is reserved').

Check warning on line 25 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L25

Use 'can't' instead of 'cannot'.

Check warning on line 25 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L25

In general, use active voice instead of passive voice ('be used').

## Configuring your MCP server

Expand All @@ -33,7 +32,7 @@

To expose endpoints as MCP tools, use the `mcp` object within the `x-mint` extension at either the file or endpoint level. For example, the Mintlify MCP server includes tools to create assistant chats, get status updates, and trigger updates.

MCP servers follow a security-first approach where API endpoints are not exposed by default. You must explicitly enable endpoints to make them available as MCP tools. Only expose endpoints that are safe for public access through AI tools.

Check warning on line 35 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L35

Use 'aren't' instead of 'are not'.

<ResponseField name="mcp" type="object">
The MCP configuration for the endpoint.
Expand Down Expand Up @@ -63,7 +62,7 @@
"enabled": true
}
},
// ...

Check warning on line 65 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L65

In general, don't use an ellipsis.
"paths": {
"/api/v1/users": {
"get": {
Expand All @@ -72,7 +71,7 @@
"enabled": false // Disables MCP for this endpoint
}
},
// ...

Check warning on line 74 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L74

In general, don't use an ellipsis.
}
}
}
Expand Down Expand Up @@ -220,7 +219,7 @@

### Example: Connecting to the Mintlify MCP server

Connect to the Mintlify MCP server to interact with the Mintlify API and search our documentation. This will give you more accurate answers about how to use Mintlify in your local environment and demonstrates how you can help your users connect to your MCP server.

Check warning on line 222 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L222

Try to avoid using first-person plural like 'our'.

Check warning on line 222 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L222

Avoid using 'will'.

<Tabs>
<Tab title="Contextual menu">
Expand All @@ -240,7 +239,7 @@
4. Select **Add**.
</Step>
<Step title="Access the MCP server in your chat">
1. When using Claude, select the attachments button (the plus icon).

Check warning on line 242 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L242

Use parentheses judiciously.
2. Select the Mintlify MCP server.
3. Ask Claude a question about Mintlify.
</Step>
Expand Down Expand Up @@ -275,7 +274,7 @@
<Step title="Open MCP settings">
1. Use <kbd>Command</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> on Windows) to open the command palette.
2. Search for "Open MCP settings".
3. Select **Add custom MCP**. This will open the `mcp.json` file.

Check warning on line 277 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L277

Avoid using 'will'.
</Step>
<Step title="Configure the Mintlify MCP server">
In `mcp.json`, add:
Expand Down
1 change: 0 additions & 1 deletion ai/slack-app.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
---
title: "Slack app"
description: "Add a bot that searches your docs to answer questions in your Slack workspace"
icon: "slack"
---

<Info>
The Slack app is available for [Pro and Custom plans](https://mintlify.com/pricing?ref=slack-app).
</Info>

The Slack app adds a bot to your Slack workspace that can search your documentation and answer users' questions. The bot responds to direct messages, @mentions, and to any questions in a channel specifically named `#ask-ai`. The bot's name is `@yourprojectname-assistant`. So if your project name is Mintlify, the bot's name is `@mintlify-assistant`.

Check warning on line 10 in ai/slack-app.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-app.mdx#L10

Did you really mean 'bot's'?

Check warning on line 10 in ai/slack-app.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-app.mdx#L10

Did you really mean 'bot's'?

The Slack app can incur costs: either using your AI assistant credits or incurring overages.

## Set up the Slack app

<Note>
If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the Mintlify Slack app before you add it.

Check warning on line 17 in ai/slack-app.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-app.mdx#L17

Use 'administrator' instead of 'admin'.
</Note>

1. Navigate to the [Add-ons](https://dashboard.mintlify.com/products/addons) page of your dashboard.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions api-playground/mdx/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
description: 'Generate docs pages for your API endpoints using `MDX`'
---

You can manually define API endpoints in individual `MDX` files rather than using an OpenAPI specification. This method provides flexibility for custom content, but we recommend generating API documentation from an OpenAPI specification file for most projects because it is more maintainable and feature-rich. However, creating `MDX` pages for an API can be useful to document small APIs or for prototyping.

Check warning on line 6 in api-playground/mdx/configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/mdx/configuration.mdx#L6

Try to avoid using first-person plural like 'we'.

Check warning on line 6 in api-playground/mdx/configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/mdx/configuration.mdx#L6

Use 'it's' instead of 'it is'.

To generate pages for API endpoints using `MDX`, configure your API settings in `docs.json`, create individual `MDX` files for each endpoint, and use components like `<ParamFields />` to define parameters. From these definitions, Mintlify generates interactive API playgrounds, request examples, and response examples.

Expand Down Expand Up @@ -33,7 +33,7 @@
}
```

Find a full list of API configurations in [Settings](/settings#api-configurations).
Find a full list of API configurations in [Settings](/organize/settings#api-configurations).
</Step>

<Step title="Create your endpoint pages">
Expand Down Expand Up @@ -76,7 +76,7 @@
</Step>

<Step title="Add your endpoints to your docs">
Add your endpoint pages to the sidebar by adding the paths to the `navigation` field in your `docs.json`. Learn more about structuring your docs in [Navigation](/navigation).
Add your endpoint pages to the sidebar by adding the paths to the `navigation` field in your `docs.json`. Learn more about structuring your docs in [Navigation](/organize/navigation).
</Step>
</Steps>

Expand All @@ -84,7 +84,7 @@

You can add an authentication method to your `docs.json` to enable it globally on every page or you can set it on a per-page basis.

A page's authentication method will override a global method if both are set.

Check warning on line 87 in api-playground/mdx/configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/mdx/configuration.mdx#L87

Avoid using 'will'.

Check warning on line 87 in api-playground/mdx/configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/mdx/configuration.mdx#L87

In general, use active voice instead of passive voice ('are set').

### Bearer token

Expand Down Expand Up @@ -158,7 +158,7 @@

### None

The `none` authentication method is useful to disable authentication on a specific endpoint after setting a default in docs.json.

Check warning on line 161 in api-playground/mdx/configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/mdx/configuration.mdx#L161

Use 'turn off' or 'off' instead of 'disable'.

<CodeGroup>
```mdx Page Metadata
Expand Down
File renamed without changes.
3 changes: 1 addition & 2 deletions api-playground/openapi-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "OpenAPI setup"
description: "Reference OpenAPI endpoints in your docs pages"
icon: "file-json"
---

OpenAPI is a specification for describing APIs. Mintlify supports OpenAPI 3.0+ documents to generate interactive API documentation and keep it up to date.
Expand All @@ -14,7 +13,7 @@

### Describing your API

We recommend the following resources to learn about and construct your OpenAPI documents.

Check warning on line 16 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L16

Try to avoid using first-person plural like 'We'.

- [Swagger's OpenAPI Guide](https://swagger.io/docs/specification/v3_0/basic-structure/) to learn the OpenAPI syntax.
- [The OpenAPI specification Markdown sources](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/) to reference details of the latest OpenAPI specification.
Expand Down Expand Up @@ -45,9 +44,9 @@

In an OpenAPI document, different API endpoints are specified by their paths, like `/users/{id}` or simply `/`. The base URL defines where these paths should be appended. For more information on how to configure the `servers` field, see [API Server and Base Path](https://swagger.io/docs/specification/api-host-and-base-path/) in the OpenAPI documentation.

The API playground uses these server URLs to determine where to send requests. If you specify multiple servers, a dropdown will allow users to toggle between servers. If you do not specify a server, the API playground will use simple mode since it cannot send requests without a base URL.

Check warning on line 47 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L47

Avoid using 'will'.

If your API has endpoints that exist at different URLs, you can [override the server field](https://swagger.io/docs/specification/v3_0/api-host-and-base-path/#overriding-servers) for a given path or operation.

Check warning on line 49 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L49

Try to avoid using first-person plural like 'our'.

### Specifying authentication

Expand Down Expand Up @@ -92,16 +91,16 @@
Common authentication types include:

- [API Keys](https://swagger.io/docs/specification/authentication/api-keys/): For header, query, or cookie-based keys.
- [Bearer](https://swagger.io/docs/specification/authentication/bearer-authentication/): For JWT or OAuth tokens.

Check warning on line 94 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L94

Spell out 'JWT', if it's unfamiliar to the audience.
- [Basic](https://swagger.io/docs/specification/authentication/basic-authentication/): For username and password.

If different endpoints within your API require different methods of authentication, you can [override the security field](https://swagger.io/docs/specification/authentication/#:~:text=you%20can%20apply%20them%20to%20the%20whole%20API%20or%20individual%20operations%20by%20adding%20the%20security%20section%20on%20the%20root%20level%20or%20operation%20level%2C%20respectively.) for a given operation.

For more information on defining and applying authentication, see [Authentication](https://swagger.io/docs/specification/authentication/) in the OpenAPI documentation.

## `x-mint` extension

Check warning on line 101 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L101

'extension' should use sentence-style capitalization.

The `x-mint` extension is a custom OpenAPI extension that provides additional control over how your API documentation is generated and displayed.

Check warning on line 103 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L103

In general, use active voice instead of passive voice ('is generated').

### Metadata

Expand Down Expand Up @@ -158,7 +157,7 @@

The `content` extension supports all Mintlify MDX components and formatting.

### Href

Check warning on line 160 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L160

'Href' should use sentence-style capitalization.

Change the URL of the endpoint page in your docs using `x-mint: href`:

Expand All @@ -185,7 +184,7 @@
}
```

When `x-mint: href` is present, the navigation entry will link directly to the specified URL instead of generating an API page.

Check warning on line 187 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L187

Avoid using 'will'.

### MCP

Expand Down Expand Up @@ -261,18 +260,18 @@

Add an `openapi` field to any navigation element in your `docs.json` to automatically generate pages for OpenAPI endpoints. You can control where these pages appear in your navigation structure, as dedicated API sections or with other pages.

The `openapi` field accepts either a file path in your docs repo or a URL to a hosted OpenAPI document.

Check warning on line 263 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L263

Use 'path' instead of 'file path'.

Generated endpoint pages have these default metadata values:

- `title`: The operation's `summary` field, if present. If there is no `summary`, the title is generated from the HTTP method and endpoint.

Check warning on line 267 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L267

In general, use active voice instead of passive voice ('is generated').
- `description`: The operation's `description` field, if present.
- `version`: The `version` value from the parent anchor or tab, if present.
- `deprecated`: The operation's `deprecated` field. If `true`, a deprecated label will appear next to the endpoint title in the side navigation and on the endpoint page.

Check warning on line 270 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L270

Avoid using 'will'.

<Tip>
To exclude specific endpoints from your auto-generated API pages, add the
[x-hidden](/api-playground/customization/managing-page-visibility#x-hidden)
[x-hidden](/api-playground/managing-page-visibility#x-hidden)
property to the operation in your OpenAPI spec.
</Tip>

Expand All @@ -283,7 +282,7 @@

### Dedicated API sections

Generate dedicated API sections by adding an `openapi` field to a navigation element and no other pages. All endpoints in the specification will be included:

Check warning on line 285 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L285

Avoid using 'will'.

Check warning on line 285 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L285

In general, use active voice instead of passive voice ('be included').

```json {5}
"navigation": {
Expand Down Expand Up @@ -366,7 +365,7 @@

#### OpenAPI spec inheritance

OpenAPI specifications are inherited down the navigation hierarchy. Child navigation elements inherit their parent's OpenAPI specification unless they define their own:

Check warning on line 368 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L368

In general, use active voice instead of passive voice ('are inherited').

```json {3, 7-8, 11, 13-14}
{
Expand All @@ -391,7 +390,7 @@

#### Individual endpoints

Reference specific endpoints without setting a default OpenAPI specification by including the file path:

Check warning on line 393 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L393

Use 'path' instead of 'file path'.

```json {5-6}
"navigation": {
Expand Down Expand Up @@ -463,7 +462,7 @@
Use our Mintlify [scraper](https://www.npmjs.com/package/@mintlify/scraping) to autogenerate `MDX` pages for large OpenAPI documents.

<Note>
Your OpenAPI document must be valid or the files will not autogenerate.

Check warning on line 465 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L465

Avoid using 'will'.

Check warning on line 465 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L465

Use 'won't' instead of 'will not'.
</Note>

The scraper generates:
Expand Down Expand Up @@ -528,7 +527,7 @@

## Webhooks

Webhooks are HTTP callbacks that your API sends to notify external systems when events occur. Webhooks are supported in OpenAPI 3.1+ documents.

Check warning on line 530 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L530

In general, use active voice instead of passive voice ('are supported').

### Define webhooks in your OpenAPI specification

Expand Down
1 change: 0 additions & 1 deletion api-playground/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Playground"
description: "Enable users to interact with your API"
icon: "play"
---

## Overview
Expand All @@ -15,7 +14,7 @@

The playground is automatically generated from your OpenAPI specification or AsyncAPI schema so any updates to your API are automatically reflected in the playground. You can also manually create API reference pages after defining a base URL and authentication method in your `docs.json`.

We recommend generating your API playground from an OpenAPI specification. See [OpenAPI Setup](/api-playground/openapi-setup) for more information on creating your OpenAPI document.

Check warning on line 17 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L17

Try to avoid using first-person plural like 'We'.

## Getting started

Expand Down Expand Up @@ -79,7 +78,7 @@
<Expandable title="playground" defaultOpen="True">
<ResponseField name="display" type="&quot;interactive&quot; | &quot;simple&quot; | &quot;none&quot;">
The display mode of the API playground.
- `"interactive"`: Display the interactive playground.

Check warning on line 81 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L81

': D' should be in lowercase.
- `"simple"`: Display a copyable endpoint with no playground.
- `"none"`: Display nothing.

Expand Down Expand Up @@ -121,7 +120,7 @@
}
```

This example configures the API playground to be interactive with example code snippets for cURL, Python, and JavaScript. Only required parameters are shown in the code snippets.

Check warning on line 123 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L123

In general, use active voice instead of passive voice ('are shown').

### Custom endpoint pages

Expand All @@ -133,9 +132,9 @@
- Add additional content like examples
- Control playground behavior per page

The `x-mint` extension is recommended so that all of your API documentation is automatically generated from your OpenAPI specification and maintained in one file.

Check warning on line 135 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L135

In general, use active voice instead of passive voice ('is recommended').

Individual `MDX` pages are recommended for small APIs or when you want to experiment with changes on a per-page basis.

Check warning on line 137 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L137

In general, use active voice instead of passive voice ('are recommended').

For more information, see [x-mint extension](/api-playground/openapi-setup#x-mint-extension) and [MDX Setup](/api-playground/mdx/configuration).

Expand Down
3 changes: 1 addition & 2 deletions api-playground/troubleshooting.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
---
title: "Troubleshooting"
description: "Common issues with API References"
icon: "message-square-warning"
---

If your API pages aren't displaying correctly, check these common configuration issues:

<AccordionGroup>
<Accordion title="All of my OpenAPI pages are completely blank">
In this scenario, it's likely that either Mintlify cannot find your OpenAPI document,

Check warning on line 10 in api-playground/troubleshooting.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/troubleshooting.mdx#L10

Use 'can't' instead of 'cannot'.
or your OpenAPI document is invalid.

Running `mint dev` locally should reveal some of these issues.
Expand Down Expand Up @@ -65,11 +64,11 @@
<Accordion title="Requests from the API Playground don't work">
If you have a custom domain configured, this could be an issue with your reverse proxy. By
default, requests made via the API Playground start with a `POST` request to the
`/_mintlify/api/request` path on the docs site. If your reverse proxy is configured to only allow `GET`

Check warning on line 67 in api-playground/troubleshooting.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/troubleshooting.mdx#L67

In general, use active voice instead of passive voice ('is configured').
requests, then all of these requests will fail. To fix this, configure your reverse proxy to

Check warning on line 68 in api-playground/troubleshooting.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/troubleshooting.mdx#L68

Avoid using 'will'.
allow `POST` requests to the `/_mintlify/api/request` path.

Alternatively, if your reverse proxy prevents you from accepting `POST` requests, you can configure Mintlify to send requests directly to your backend with the `api.playground.proxy` setting in the `docs.json`, as described in the [settings documentation](/settings#param-proxy). When using this configuration, you will need to configure CORS on your server since requests will come directly from users' browsers rather than through your proxy.
Alternatively, if your reverse proxy prevents you from accepting `POST` requests, you can configure Mintlify to send requests directly to your backend with the `api.playground.proxy` setting in the `docs.json`, as described in the [settings documentation](/organize/settings#param-proxy). When using this configuration, you will need to configure CORS on your server since requests will come directly from users' browsers rather than through your proxy.
</Accordion>
<Accordion title="OpenAPI navigation entries are not generating pages">
If you are using an OpenAPI navigation configuration, but the pages aren't generating, check these common issues:
Expand Down
1 change: 0 additions & 1 deletion api-reference/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
title: "Introduction"
description: "Trigger updates, embed AI assistant, and more"
icon: "book-open"
---

The Mintlify REST API enables you to programmatically interact with your documentation, trigger updates, and embed AI-powered chat experiences.

Check warning on line 6 in api-reference/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-reference/introduction.mdx#L6

Spell out 'REST', if it's unfamiliar to the audience.

## Endpoints

Expand All @@ -13,28 +12,28 @@
- [Create agent job](/api-reference/agent/create-agent-job): Create an agent job to automatically edit your documentation.
- [Get agent job](/api-reference/agent/get-agent-job): Retrieve the details and status of a specific agent job.
- [Get all agent jobs](/api-reference/agent/get-all-jobs): Retrieve all agent jobs for a domain.
- [Generate assistant message](/api-reference/assistant/create-assistant-message): Embed the assistant, trained on your docs, into any application of your choosing.

Check warning on line 15 in api-reference/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-reference/introduction.mdx#L15

Use 'app' instead of 'application'.
- [Search documentation](/api-reference/assistant/search): Search through your documentation.

## Authentication

You can generate an API key through [the dashboard](https://dashboard.mintlify.com/settings/organization/api-keys). API keys are associated with an entire organization and can be used across multiple deployments.

Check warning on line 20 in api-reference/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-reference/introduction.mdx#L20

In general, use active voice instead of passive voice ('are associated').

Check warning on line 20 in api-reference/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-reference/introduction.mdx#L20

In general, use active voice instead of passive voice ('be used').

### Admin API key

The admin API key is used for the [Trigger update](/api-reference/update/trigger), [Get update status](/api-reference/update/status), and all agent endpoints.

Check warning on line 24 in api-reference/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-reference/introduction.mdx#L24

Use 'administrator' instead of 'admin'.

Check warning on line 24 in api-reference/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-reference/introduction.mdx#L24

In general, use active voice instead of passive voice ('is used').

Admin API keys begin with the `mint_` prefix. Keep your admin API keys secret.

Check warning on line 26 in api-reference/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-reference/introduction.mdx#L26

Use 'administrator' instead of 'admin'.

### Assistant API key

The assistant API key is used for the [Generate assistant message](/api-reference/assistant/create-assistant-message) and [Search documentation](/api-reference/assistant/search) endpoints.

Check warning on line 30 in api-reference/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-reference/introduction.mdx#L30

In general, use active voice instead of passive voice ('is used').

Assistant API keys begin with the `mint_dsc_` prefix.

The assistant API **key** is a server-side token that should be kept secret.

Check warning on line 34 in api-reference/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-reference/introduction.mdx#L34

In general, use active voice instead of passive voice ('be kept').

The assistant API **token** is a public token that can be referenced in your frontend code.

Check warning on line 36 in api-reference/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-reference/introduction.mdx#L36

In general, use active voice instead of passive voice ('be referenced').

<Note>
Calls using the assistant API token can incur costs: either using your AI assistant credits or incurring overages.
Expand Down
3 changes: 1 addition & 2 deletions authentication-personalization/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Overview"
description: "Control who sees your documentation and customize their experience"
icon: "badge-info"
keywords: ["auth"]
---

Expand All @@ -27,7 +26,7 @@

**Choose partial authentication when:**
- Offering public getting-started guides with private advanced features
- Publishing open-source docs with private enterprise sections

Check warning on line 29 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L29

Use 'open source' instead of 'open-source'.

**Choose personalization when:**
- Creating public API documentation that shows user-specific examples
Expand All @@ -40,7 +39,7 @@

| Method | Available for | Setup complexity | Best for |
|:-------|:--------------|:-----------------|:----------|
| **JWT** | All approaches | Medium | Custom login flows, maximum security control |

Check warning on line 42 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L42

Spell out 'JWT', if it's unfamiliar to the audience.
| **OAuth 2.0** | All approaches | High | Third-party auth providers, enterprise security |
| **Mintlify Dashboard** | Authentication only | Low | Teams already using Mintlify dashboard |
| **Password** | Authentication only | Low | Simple shared access without personalization |
Expand All @@ -48,16 +47,16 @@

### When to use each method

**JWT**: Use when you have an existing authentication system and want full control over the login flow. Ideal for custom user management or when you need to decouple documentation access from your main application.

Check warning on line 50 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L50

Spell out 'JWT', if it's unfamiliar to the audience.

Check warning on line 50 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L50

': U' should be in lowercase.

Check warning on line 50 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L50

Use 'app' instead of 'application'.

**OAuth 2.0**: Use when you want to leverage third-party authentication providers (Google, GitHub, etc.) or need enterprise-grade security standards. Best for organizations already using OAuth infrastructure.

Check warning on line 52 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L52

': U' should be in lowercase.

**Mintlify Dashboard**: Use when your documentation editors are also your documentation readers. Perfect for internal teams who already manage content through the Mintlify dashboard.

Check warning on line 54 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L54

': U' should be in lowercase.

**Password**: Use for simple access control when you don't need to track individual users or personalize content. Good for contractors, beta users, or temporary access scenarios.

Check warning on line 56 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L56

': U' should be in lowercase.

**Shared Session**: Use when you want seamless login between your application and documentation. Ideal when users are already authenticated in your main application and you want to personalize their documentation experience.

Check warning on line 58 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L58

': U' should be in lowercase.

Check warning on line 58 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L58

Use 'app' instead of 'application'.

Check warning on line 58 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L58

Use 'app' instead of 'application'.

## Content customization

All three approaches support content personalization features including dynamic MDX content, API key prefilling, and page visibility controls. For detailed implementation guidance, see [Personalization setup](/authentication-personalization/personalization-setup).
All three approaches support content personalization features including dynamic MDX content, API key prefilling, and page visibility controls. For detailed implementation guidance, see [Personalization setup](/deploy/personalization-setup).
8 changes: 4 additions & 4 deletions changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@

- Added support for Romanian and Czech languages in the documentation interface
- Enhanced localization capabilities with complete translation coverage for new languages
- Improved language selector functionality across all themes

Check warning on line 14 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L14

Use 'capability' or 'feature' instead of 'functionality'.

## UI and user experience improvements

Check warning on line 16 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L16

'UI and user experience improvements' should use sentence-style capitalization.

- Fixed tab visibility issues on 404 pages to prevent incorrect active tab highlighting
- Enhanced image handling with proper width and height attribute passing for non-optimized images
Expand All @@ -21,7 +21,7 @@

## Infrastructure and performance enhancements

- Enhanced GIF image processing by skipping costly Imgix auto-formatting to reduce processing time and bandwidth usage

Check warning on line 24 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L24

Spell out 'GIF', if it's unfamiliar to the audience.

Check warning on line 24 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L24

Did you really mean 'Imgix'?
- Optimized image serving performance with special handling for animated content

## Bug fixes and reliability
Expand All @@ -46,11 +46,11 @@

## Bug fixes and reliability

- Fixed app router socket update functionality for real-time features

Check warning on line 49 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L49

Use 'capability' or 'feature' instead of 'functionality'.
- Fixed SVG path rendering issues in documentation
- Fixed keyboard navigation in search and chat functionality

Check warning on line 51 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L51

Use 'capability' or 'feature' instead of 'functionality'.
- Fixed history status endpoint reliability
- Resolved middleware edge cases and onClick event handling issues

Check warning on line 53 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L53

Did you really mean 'onClick'?

</Update>

Expand All @@ -60,14 +60,14 @@

- **Major enhancement**: AI suggested pages on 404 pages, [when someone hits a dead link → AI agent reads the path → suggests semantically similar pages](https://x.com/mintlify/status/1966625627773059495)
- **Major release**: web search for assistant can now include external sources
_Note: Contact us to enable this feature for your site._

Check warning on line 63 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L63

Try to avoid using first-person plural like 'us'.

## Assistant and MCP

- Fixed a bug where the assistant would be incorrectly rate limited due to time window not sliding correctly
- Fixed a bug with assistant tool calling to properly handle empty `text` blocks
- Fixed a bug where MCP server name's concatenated with tool calls were sometimes exceeding the 60 character length MCP clients enforce
- Fixed a bug where the assistant menu would have a height several times larger than the viewport and scroll forever

Check warning on line 70 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L70

Did you really mean 'viewport'?
- Fixed a bug where assistant spend values could display with greater than two decimal places in the dashboard

## Web editor and deployments
Expand All @@ -75,20 +75,20 @@
- Security enhancement added to editor such that only users with `write permissions` for the connected git hosting repository can make changes
- Fixed a bug where preview deployments wouldn't work for branches with `=` in the name
- Fixed a bug where long branch names would overflow modals on preview deployment creations
- Quality of life improvement where email query parameter will prefill the input on signup invitations

Check warning on line 78 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L78

Avoid using 'will'.

Check warning on line 78 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L78

Did you really mean 'signup'?
- Fixed a bug where copying a page from the context menu was not working on safari

Check warning on line 79 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L79

Use 'wasn't' instead of 'was not'.

## API playground and navigation

- Multiple API playground response codes now display in a controlled styled select menu instead of the system default select menu when focused
- You can now use the [`expanded` field on navigation groups in your `docs.json` to make them be default open](https://mintlify.com/docs/navigation#default-expanded-state)

## SEO and UI

Check warning on line 86 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L86

'SEO and UI' should use sentence-style capitalization.

Check warning on line 86 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L86

Spell out 'SEO', if it's unfamiliar to the audience.

- Fixed a bug where favicons were not showing up in search engines by serving them from the same URL as the documentation site itself for each respective site

Check warning on line 88 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L88

Use 'weren't' instead of 'were not'.
- Fixed a bug where youtube embeds would flash in and out on load

Check warning on line 89 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L89

Did you really mean 'youtube'?
- Fixed a bug where expanding the feedback menu to include written responses would cause layout shift with the table of contents
- Fixed a bug where text would leak above the topbar on the maple theme when a dismissed the notification banner

Check warning on line 91 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L91

Use 'preceding' instead of 'above'.
- Enhanced the Maple and Willow themes by adding login/logout buttons to the sidebar for easier access

## Analytics and exports
Expand All @@ -103,7 +103,7 @@
## Major release: Enhanced feedback collection

- **Major improvement**: Readers can now give more detailed feedback after selecting *thumbs up/down*, including options and written comments. You can also collect feedback on code blocks and view all responses in your dashboard analytics.
_Note: Contact us to enable this feature for your site._

Check warning on line 106 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L106

Try to avoid using first-person plural like 'us'.

## Navigation and quality of life improvements

Expand All @@ -119,16 +119,16 @@
- Fixed a bug where Google was indexing raw `*.md` files because they were missing a `x-robots-tag noindex` header
- Fixed a bug with OAuth on protected docs where it wouldn't redirect you back to your starting page once you completed the flow successfully
- Fixed a bug on previews of auth protected docs where you weren't able to see the entire navigation bar
- Bug fixes to how SVGs are handled with our new image CDN

Check warning on line 122 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L122

In general, use active voice instead of passive voice ('are handled').

Check warning on line 122 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L122

Try to avoid using first-person plural like 'our'.

Check warning on line 122 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L122

Spell out 'CDN', if it's unfamiliar to the audience.

## Component and styling enhancements

- Added a new CSS selector for custom styles on `SidebarNavGroupDivider`
- New regression tests for MDX defined API pages that have security defined on them will ensure a greater degree of stability

Check warning on line 127 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L127

Avoid using 'will'.

## Performance improvements

- Performance improvement by moving the KaTeX CSS from cdnjs to our own CDN on Cloudfront for reduced latency

Check warning on line 131 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L131

Did you really mean 'cdnjs'?

Check warning on line 131 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L131

Try to avoid using first-person plural like 'our'.

Check warning on line 131 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L131

Spell out 'CDN', if it's unfamiliar to the audience.

</Update>

Expand All @@ -137,18 +137,18 @@
## Image handling improvements

- **Major improvement**: Images no longer cause layout shift by default, even when width and height attributes aren't specified—automatic sizing prevents content jumping during page loads
- All static files in your repository (PDF, TXT, XML, etc.) are now automatically uploaded and served when you deploy, providing complete asset coverage

Check warning on line 140 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L140

Use parentheses judiciously.

Check warning on line 140 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L140

Spell out 'TXT', if it's unfamiliar to the audience.

## Web editor and deployment enhancements

- Fixed branch creation workflow in web editor to correctly navigate to and stay on newly created branches
- Enhanced merge conflict dialog with proper escape functionality, no more page reloads required to dismiss conflicts

Check warning on line 145 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L145

Use 'capability' or 'feature' instead of 'functionality'.
- Optimized update workflow performance by cache-invalidating only changed pages during partial updates, reducing deployment times

## Authentication and navigation improvements

- New support for authentication on custom subdirectories, if you serve docs at `https://yourdomain.com/docs`, authentication now works seamlessly
- Fixed sidebar display bug that incorrectly showed when only one link was configured

Check warning on line 151 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L151

In general, use active voice instead of passive voice ('was configured').
- Comprehensive mobile navigation overhaul: centered buttons with proper margin/padding, improved spacing in dropdown menus, removed unnecessary dividers and margins for empty sections, and fixed Maple theme gap/padding issues

## Component and styling fixes
Expand All @@ -160,7 +160,7 @@

- Enhanced logging system for update workflows enabling faster debugging and issue resolution
- Fixed GitHub rate limiting for customers with 10+ OpenAPI/AsyncAPI specs by switching from individual file fetching to repository cloning
- Improved assistant reliability with backup LLM support, enhanced rate limit error handling, and more robust search tool functionality

Check warning on line 163 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L163

Spell out 'LLM', if it's unfamiliar to the audience.

Check warning on line 163 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L163

Use 'capability' or 'feature' instead of 'functionality'.

</Update>

Expand All @@ -169,16 +169,16 @@
## Performance and build optimizations

- MDX transpilation now happens at deployment time instead of on every page load in uncached NextJS serverless environments, improving time to first byte for uncached pages.
- Content-based hashing prevents re-transpilation when MDX hasn't changed, reducing update workflow times by ~50% for customers with large page counts (deployments over 5 minutes should be roughly halved)

Check warning on line 172 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L172

Use parentheses judiciously.
- Preview deployment viewing in the dashboard is now faster with added database indexes and query parallelization in our backend

Check warning on line 173 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L173

Did you really mean 'parallelization'?

Check warning on line 173 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L173

Try to avoid using first-person plural like 'our'.
- Reduced page size by eliminating duplicate `navigation` data in each page's `rsc` payload—performance gains most noticeable with high page counts or complex navigation structures
- More aggressive prefetching enables instant page loads more frequently

Check warning on line 175 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L175

Did you really mean 'prefetching'?

## API playground and OpenAPI enhancements

- OpenAPI to MCP conversion moved to backend, enabling hosted MCP servers to contain tools (expect clearer documentation and config options soon)
- Added Ruby support to API playground
- We added a feature such that you can now [specify API pages using just your docs.json](/api-playground/openapi-setup#auto-populate-api-pages) without creating any new mdx files.

Check warning on line 181 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L181

Try to avoid using first-person plural like 'We'.
- Support for [`webhook` pages](/api-playground/openapi-setup#webhooks) in docs navigation from OpenAPI specs
- Optimized AI model context by removing anchor link specifications from markdown links when navigating to Anthropic, OpenAI, or other providers

Expand All @@ -187,20 +187,20 @@
- File creation/renaming now saves changes when clicking away instead of requiring Enter key press
- Fixed branch navigation where changing URL to specific branch would redirect to last active branch instead of intended destination
- Properly URL encode branch titles containing `/` to prevent navigation breakage
- Fixed `Ctrl+K` link shortcut in monorepo dashboard Editor that was prepending docs repo path and creating broken links

Check warning on line 190 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L190

Did you really mean 'prepending'?

## Analytics and LLM integrations

Check warning on line 192 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L192

'Analytics and LLM integrations' should use sentence-style capitalization.

Check warning on line 192 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L192

Spell out 'LLM', if it's unfamiliar to the audience.

- Custom `llms.txt` and `llms-full.txt` support—add to docs repo root to serve at `/llms.txt` and `/llms-full.txt` endpoints for LLM customization

Check warning on line 194 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L194

Spell out 'LLM', if it's unfamiliar to the audience.
- Added [Hightouch analytics integration](/integrations/analytics/hightouch#hightouch)
- Enhanced context menu analytics tracking (dashboard viewing coming soon)

Check warning on line 196 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L196

Use parentheses judiciously.
- Added e2e tests for `llms.txt` and `llms-full.txt` to ensure correct serving

## Component and styling enhancements

- Support for custom classnames in `h{1-4}` tags for applying custom heading styles

Check warning on line 201 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L201

Did you really mean 'classnames'?
- Fixed `h{1-4}` tags rendering as `Heading` components with chips in custom page mode
- Added CSS selectors to [breadcrumbs](/navigation#breadcrumbs) for custom CSS targeting
- Added CSS selectors to [breadcrumbs](/organize/navigation#breadcrumbs) for custom CSS targeting
- Fixed stretched open-graph images by analyzing dimensions to maintain proportions at 56px height
- Corrected `VSCode` to `VS Code` in contextual menu when enabled
- Fixed headings within custom components appearing in table of contents alongside semantic headings
Expand All @@ -208,10 +208,10 @@
## Bug fixes and reliability

- Fixed PDF render issues with certain page titles by sanitizing characters that cause generation problems
- Resolved CLI error `Cannot convert undefined or null to object` when encountering empty OpenAPI JSON files

Check warning on line 211 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L211

Use 'command-line tool' instead of 'CLI'.
- Fixed custom `docs.json` open-graph metatags being overwritten by generated ones

Check warning on line 212 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L212

Did you really mean 'metatags'?
- Fixed RSS feed button clicks when landing on anchor links by using origin + pathname for RSS links

Check warning on line 213 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L213

Spell out 'RSS', if it's unfamiliar to the audience.

Check warning on line 213 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L213

Use 'path' instead of 'pathname'.

Check warning on line 213 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L213

Spell out 'RSS', if it's unfamiliar to the audience.
- Improved CLI download speed by removing sourcemaps

Check warning on line 214 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L214

Use 'command-line tool' instead of 'CLI'.

Check warning on line 214 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L214

Did you really mean 'sourcemaps'?

## Technical improvements

Expand All @@ -226,40 +226,40 @@

- Group-level public access: make entire page groups public via `docs.json` so you don’t need `public: true` on each page ([learn more](https://mintlify.com/docs/authentication-personalization/authentication-setup#group-level))
- Support [`logoutURL` in OAuth configuration](https://mintlify.com/docs/authentication-personalization/authentication-setup#implementation-3) to delete upstream cookies and complete sign-out
- On OAuth errors, users are redirected to your specified `logoutURL` to restart the auth flow

Check warning on line 229 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L229

In general, use active voice instead of passive voice ('are redirected').
- Fixed a flash of a 500 error during OAuth/JWT flows before the callback

Check warning on line 230 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L230

Spell out 'JWT', if it's unfamiliar to the audience.
- Auto-strip `https://` from URLs in OAuth/JWT auth configuration to prevent misconfiguration

Check warning on line 231 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L231

Spell out 'JWT', if it's unfamiliar to the audience.

Check warning on line 231 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L231

Did you really mean 'misconfiguration'?

## API playground enhancements

- New [Search API endpoint](https://mintlify.com/docs/api-reference/assistant/search) so you can build agents and MCP servers on top of your docs
- `openapi` and `asyncapi` files are now served at their specified paths (for example, `https://mydocsurl.extension/{openapi-or-file-name}.json`)
- You can now use the [`x-mint` field in your openapi files](https://mintlify.com/docs/api-playground/openapi-setup#x-mint-extension) to override generated fields, customize preface content, or change endpoint URLs in code samples
- [`x-mcp` is now `x-mint.mcp`](https://mintlify.com/docs/api-playground/openapi-setup#mcp) in OpenAPI configurations to control which routes are exposed as MCP tools

Check warning on line 238 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L238

In general, use active voice instead of passive voice ('are exposed').

## Assistant updates

- Fixed an issue where the action menu (containing options like copy and thumbs up) for older messages disappeared when new ones streamed in

Check warning on line 242 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L242

Use parentheses judiciously.
- Fixed accessibility of nested `/mcp/...` pages after the [hosted MCP servers release](https://mintlify.com/docs/ai/model-context-protocol#accessing-your-mcp-server) from last week

## Performance and reliability

- All image and video assets present in your docs repo are now served at the appropriate path on your domain. For example, if you have `/assets/marketing/my-logo.png` in your repo, it will be available at `https://mydocsurl.extension/assets/marketing/my-logo.png`.

Check warning on line 247 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L247

Avoid using 'will'.
- Email field on login for the Mintlify dashboard now autofocuses so you can start typing immediately _(quality of life improvement)_

Check warning on line 248 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L248

Use 'email' instead of 'Email'.

Check warning on line 248 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L248

Did you really mean 'autofocuses'?

Check warning on line 248 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L248

Use parentheses judiciously.
- Both custom domains and subdomains in Redis for a performance improvement on navigation load times (~50ms latency reduction)

Check warning on line 249 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L249

Use parentheses judiciously.

Check warning on line 249 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L249

Put a nonbreaking space between the number and the unit in '50ms'.
- Added retry logic for PDF exports to improve reliability
- Fixed cookie consent popup reappearing after acceptance or dismissal—first selection is now respected
- Fixed copying a page to clipboard on Safari by specifying a MIME `type` in `navigator.write`

## Technical improvements

- CLI bugfixes for windows and pnpm, plus CI tests to prevent regressions

Check warning on line 256 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L256

Use 'command-line tool' instead of 'CLI'.

Check warning on line 256 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L256

Did you really mean 'bugfixes'?
- Improved error logging output—a quality of life upgrade for our engineering team when debugging

Check warning on line 257 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L257

Try to avoid using first-person plural like 'our'.
- Minor fixes to the broken-link CI action when `contentDirectory` files are missing
- Fixed a regression caused by the auth-protected preview fixes from last week where the active tab was not being set correctly in the navigation UI

Check warning on line 259 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L259

Use 'wasn't' instead of 'was not'.

Check warning on line 259 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L259

In general, use active voice instead of passive voice ('being set').
- Fixed theme light background color not being applied to active tab icons

Check warning on line 260 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L260

In general, use active voice instead of passive voice ('being applied').
- Fixed an issue where changing the auth type in the dashboard would update and then flip back to the previously saved type—now the new selection persists after saving
- Internal DX improvements for enterprise customers with custom UI libraries—it's now easier for us to include your components and accommodate requests on shorter timelines

Check warning on line 262 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L262

Try to avoid using first-person plural like 'us'.
</Update>

<Update label="July 27 - August 2" tags={["Improvements"]} rss={{ title: "Weekly Updates", description: "Authentication improvements, search enhancements, and assistant API" }}>
Expand All @@ -268,11 +268,11 @@
- Local development improvements to auth, enabling faster development of auth features and bug fixes in this product area
- Preview deployments now available for auth-protected sites
- Fixed redirect behavior to properly return users to their original page after authentication
- Fixed logout button display for full authentication (previously only worked for partial authentication)

Check warning on line 271 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L271

Use parentheses judiciously.

## API playground enhancements

- Fixed `multipart/form-data` file upload functionality in the API playground

Check warning on line 275 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L275

Use 'capability' or 'feature' instead of 'functionality'.
- Fixed anchor link behavior so clicking them updates the URL without scrolling to top of page
- Fixed anchor link issues in nested tabs

Expand All @@ -284,15 +284,15 @@

## Performance and reliability

- Made search feel more crisp and accurate by aborting debounced requests as you type

Check warning on line 287 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L287

Did you really mean 'debounced'?
- Resource provisions for a new CDN - expect image asset and page load times to improve soon

Check warning on line 288 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L288

Spell out 'CDN', if it's unfamiliar to the audience.
- Fixed bugs for rendering complex Mermaid diagrams like GANTT charts

Check warning on line 289 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L289

Spell out 'GANTT', if it's unfamiliar to the audience.
- Fixed CLI bugs on Windows to improve stability and added tests to prevent regression

Check warning on line 290 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L290

Use 'command-line tool' instead of 'CLI'.

## Technical improvements

- Added OpenTelemetry for traces in NextJS application to improve time to first byte for customers

Check warning on line 294 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L294

Use 'app' instead of 'application'.
- Migrated from Octokit to GitHub API Client to improve latency in the web editor experience

Check warning on line 295 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L295

Did you really mean 'Octokit'?
- Fixed duplicate meta tags for OpenGraph
- Upgraded MongoDB from version 6 to 7 for improved performance and new features
</Update>
Expand All @@ -300,16 +300,16 @@
<Update label="July 2025" tags={["New releases", "Improvements"]} rss={{ title: "July Product Updates", description: "Slack app integration, hosted MCP servers, Cursor integration, and performance improvements" }}>
## Slack app

- Zero friction access: Bot responds to DMs, @mentions, and any question in your `#ask-ai` channel

Check warning on line 303 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L303

Did you really mean 'DMs'?
- One-click setup: Install directly from your Mintlify dashboard in seconds
- Contextual answers: Searches your entire documentation to provide relevant, accurate responses
- Deflect support interruptions: Turn daily questions into instant, self-serve answers

Learn more in our [Slack app guide](/ai/slack-app).

Check warning on line 308 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L308

Try to avoid using first-person plural like 'our'.

## Hosted MCP servers

Deploy hosted Model Context Protocol (MCP) servers directly through Mintlify to integrate with AI tool like Claude, Cursor, and others. Learn more in our [MCP guide](/ai/model-context-protocol).

Check warning on line 312 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L312

Try to avoid using first-person plural like 'our'.

Help users quickly connect your MCP server to Cursor or VS Code from any page in your docs via the contextual menu. See [Contextual menu](/ai/contextual-menu) for more information.

Expand All @@ -322,18 +322,18 @@
<Update label="June 2025" tags={["New releases", "Improvements"]} rss={{ title: "June Product Updates", description: "AI assistant updates and subscribable changelogs" }}>
## AI assistant updates

- Improved accuracy through agentic RAG with tool calling

Check warning on line 325 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L325

Spell out 'RAG', if it's unfamiliar to the audience.
- Provides navigable links to referenced pages so that users can go directly to the source of answers
- Copy shortcut for code examples generated by assistant
- "Ask AI" shortcut on code blocks in documentation to generate explanations from the assistant

Learn more in the [assistant docs](/guides/assistant).
Learn more in the [assistant docs](/ai/assistant).

## Subscribable changelogs
- Automatically generate an RSS feed from changelog pages

Check warning on line 333 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L333

Spell out 'RSS', if it's unfamiliar to the audience.
- Integrate RSS-enabled updates with Slack, email, and other tools

Check warning on line 334 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L334

Spell out 'RSS', if it's unfamiliar to the audience.

Learn more in our new [Changelog guide](/guides/changelogs)
Learn more in our new [Changelog guide](/create/changelogs)

Check warning on line 336 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L336

Try to avoid using first-person plural like 'our'.

</Update>

Expand All @@ -348,14 +348,14 @@
Learn more at [API playground docs.](/api-playground/)

## `mint update`
Can now use `mint update` to update your CLI.

Check warning on line 351 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L351

Use 'command-line tool' instead of 'CLI'.
</Update>

<Update label="April 2025" tags={["New releases", "Improvements"]}>
## Web Editor 3.0

Check warning on line 355 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L355

'Web Editor 3.0' should use sentence-style capitalization.

<Frame>
![Webeditor3 Jpe](/images/webeditor3.jpeg)

Check warning on line 358 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L358

Did you really mean 'Jpe'?
</Frame>
Overhauled usability in the WYSIWYG editor.

Expand All @@ -364,21 +364,21 @@
- Search for file names using ⌘ \+ P shortcut
- Pages load 10x faster
- Faster load times when searching for a branch
- Page options tab to configure layout, title, & metadata for SEO

Check warning on line 367 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L367

Spell out 'SEO', if it's unfamiliar to the audience.
- Floating toolbar when you highlight text

**Additional fixes**

- Fixed top margin for changelog components
- Improved reliability of right click behavior
- After clicking publish, you’ll stay on the same page instead of being brought to an empty state

Check warning on line 374 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L374

In general, use active voice instead of passive voice ('being brought').
- Standardized colors in file icons
- Improved reliability after selecting new branches several times in a row
- Removed Diff mode
- More consistency when creating a new folder from the dropdown
- Fixed block quotes creating more block quotes when trying to deselect

## AI Translations in beta

Check warning on line 381 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L381

'AI Translations in beta' should use sentence-style capitalization.

<Frame>
![AI Translations graphic](/images/changelog/translations.png)
Expand Down Expand Up @@ -413,10 +413,10 @@

- OG images fixed
- Fixed icon style inconsistency for anchors without container
- Improved styling nits for dashboard border for mobile-tablet-desktop responsiveness

Check warning on line 416 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L416

Use 'device' instead of 'tablet'.
- Show code examples even when in simple mode for API playground
- Support "command \+ k" shortcut for search in web editor
- Codeblocks within callouts expand to fill the width of the callout area

Check warning on line 419 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L419

Did you really mean 'Codeblocks'?
</Update>

<Update label="February 2025" tags={["New releases", "Improvements"]}>
Expand All @@ -429,7 +429,7 @@

Upgrade from `mint.json` to `docs.json` with the following steps:

1. Make sure your CLI is the latest version

Check warning on line 432 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L432

Use 'command-line tool' instead of 'CLI'.

```bash
npm i mint@latest -g
Expand All @@ -443,15 +443,15 @@

1. Delete your old `mint.json` file and push your changes

## CI Checks

Check warning on line 446 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L446

'CI Checks' should use sentence-style capitalization.

Automatically lint your docs to find broken links, discover spelling and grammar issues, or enforce writing styles with your own Vale config. Learn more in our [docs](settings/ci).

Check warning on line 448 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L448

Try to avoid using first-person plural like 'our'.

## .md support for LLMs

All documentation pages are now automatically available as plain Markdown files—just append `.md` to the URL. This makes it easier for LLMs to ingest individual pages from your documentation.

Check warning on line 452 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L452

Use 'import' or 'load' instead of 'ingest'.

## More Themes

Check warning on line 454 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L454

'More Themes' should use sentence-style capitalization.

<Frame>
![graphic with text "Themes v2"](/images/changelog/themes.png)
Expand All @@ -468,24 +468,24 @@

- [Guide to Technical Writing:](https://mintlify.com/guides/introduction)Best practices for writing technical documentation, including audience research, content types, and writing tips.
- [Dropdown component](navigation#dropdowns): Organize navigation with a dropdown, in addition to tabs and anchors.
- [AI syntax fixer](https://x.com/ricardonunez_io/status/1892334887644123192): The web editor will catch if there’s a parsing error and use AI to suggest fixes.

Check warning on line 471 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L471

Avoid using 'will'.
</Update>

<Update label="January 2025" tags={["Improvements"]}>
## AI Assistant Improvements

Check warning on line 475 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L475

'AI Assistant Improvements' should use sentence-style capitalization.

- New UI with dedicated chat page & pre-filled prompts
- Stability improvements. For example, bug fixes of editing the wrong file or no files at all
- More robust knowledge for adding & editing components
- Improved `docs.json` file editing

## Partial Authentication

Check warning on line 482 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L482

'Partial Authentication' should use sentence-style capitalization.

Customize access to any page or section of content depending on user permissions. Supports connecting with your own authentication system.

## Revamped API Playground

Check warning on line 486 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L486

'Revamped API Playground' should use sentence-style capitalization.

We’ve overhauled the design and performance of the [API Playground](/api-playground/). Updates include:

Check warning on line 488 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L488

Try to avoid using first-person plural like 'We'.

- Easier detail expansion for an overview of a field
- More intuitive nested design. For example, adding or deleting items
Expand All @@ -506,27 +506,27 @@
</Update>

<Update label="November 2024">
## AI Writer

Check warning on line 509 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L509

'AI Writer' should use sentence-style capitalization.

<Frame>
![AI Assistant](/images/changelog/ai-assistant.jpg)
</Frame>
You can now ask AI to make changes to your docs, with the context of all existing documentation. Type in a prompt and the writer will propose changes by generating a pull request.

## GitLab Integration Upgrade

Check warning on line 516 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L516

'GitLab Integration Upgrade' should use sentence-style capitalization.

We've improved our support for syncing with GitLab, such as enabling automated updates and preview deployments. Check out our [docs on GitLab](/settings/gitlab) to get started.
We've improved our support for syncing with GitLab, such as enabling automated updates and preview deployments. Check out our [docs on GitLab](/deploy/gitlab) to get started.

Check warning on line 518 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L518

Try to avoid using first-person plural like 'We'.

Check warning on line 518 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L518

Try to avoid using first-person plural like 'our'.

## Web Editor

Check warning on line 520 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L520

'Web Editor' should use sentence-style capitalization.

<Frame>
![Web Editor](/images/changelog/webeditor.jpg)
</Frame>
We've revamped our web editor so that you can now update docs with a fully WYSIWYG experience, while syncing with markdown.

Check out our [docs on getting started with Web Editor](/editor).

Check warning on line 527 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L527

Try to avoid using first-person plural like 'our'.

## /llms.txt support

Check warning on line 529 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L529

'/llms.txt support' should use sentence-style capitalization.

<Frame>
![llms.txt support](/images/changelog/llms.jpg)
Expand All @@ -535,30 +535,30 @@

## Localization

You can now localize your docs which operates similarly to versioning. Add a `locale` to a version and fixed content in Mintlify like "Was this page helpful?" will also match the locale.

Check warning on line 538 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L538

Avoid using 'will'.

### Quality Improvements

- Return chat & search results based on the current version that the user is reading
- Authenticate users with OAuth, in addition to JWT or Shared Session tokens.

Check warning on line 543 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L543

Spell out 'JWT', if it's unfamiliar to the audience.
</Update>

<Update label="October 2024">
## Changelogs

Launched a new [Update component](/components/update) to make it easier to display and report updates (like this one) to your users.

Check warning on line 549 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L549

Use parentheses judiciously.

<Frame>
![Changelog](/images/changelog/changelog.jpg)
</Frame>
## Code Line Highlighting

Check warning on line 554 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L554

'Code Line Highlighting' should use sentence-style capitalization.

You can now highlight lines of code in your docs to emphasize and bring attention to important parts by adding a special comment after the language identifier. Use curly braces `{}` and specify line numbers or ranges separated by commas.

```javascript Line Highlighting Example {1,3-5}
const greeting = "Hello, World!";

Check warning on line 559 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L559

Use semicolons judiciously.
function sayHello() {
console.log(greeting);

Check warning on line 561 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L561

Use semicolons judiciously.
}
sayHello();
```
Expand Down
1 change: 0 additions & 1 deletion components/accordions.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Accordions"
description: "Collapsible components to show and hide content"
icon: "chevron-down"
---

import IconsOptional from "/snippets/icons-optional.mdx";
Expand Down
1 change: 0 additions & 1 deletion components/banner.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
title: "Banner"
description: "Add a banner to display important site-wide announcements and notifications"
icon: "layout-panel-top"
---

Use banners to display important announcements, updates, or notifications across your entire documentation site. Banners appear at the top of every page, support Markdown formatting, and can be made dismissible.

Check warning on line 6 in components/banner.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/banner.mdx#L6

In general, use active voice instead of passive voice ('be made').

To add a banner, use the `banner` property in your `docs.json`:

Expand Down
1 change: 0 additions & 1 deletion components/callouts.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
title: 'Callouts'
description: 'Use callouts to add eye-catching context to your content'
icon: 'info'
---

Callouts can be styled as a Note, Warning, Info, Tip, Check, Danger, or create your own callout:

Check warning on line 6 in components/callouts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/callouts.mdx#L6

In general, use active voice instead of passive voice ('be styled').

<Note>This adds a note in the content</Note>

Expand Down
1 change: 0 additions & 1 deletion components/cards.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Cards"
description: "Highlight main points or links with customizable layouts and icons"
icon: "square-mouse-pointer"
---

import IconsOptional from "/snippets/icons-optional.mdx";
Expand Down
3 changes: 1 addition & 2 deletions components/code-groups.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Code groups"
description: "Display multiple code examples in one component"
icon: "group"
---

Use the `CodeGroup` component to display multiple code blocks in a tabbed interface, allowing users to compare implementations across different programming languages or see alternative approaches for the same task.
Expand All @@ -26,7 +25,7 @@ class HelloWorld {

</CodeGroup>

Code groups inherit global styling from your `docs.json` file. Customize your theme using `styling.codeblocks`. See [Settings](/settings#styling) for configuration options.
Code groups inherit global styling from your `docs.json` file. Customize your theme using `styling.codeblocks`. See [Settings](/organize/settings#styling) for configuration options.

## Creating code groups

Expand Down
1 change: 0 additions & 1 deletion components/columns.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: 'Columns'
description: 'Show cards side by side in a grid format'
icon: 'columns-2'
keywords: ['card groups']
---

Expand All @@ -9,7 +8,7 @@

<Columns cols={2}>
<Card title="Get started" icon="rocket">
Set up your project with our quickstart guide.

Check warning on line 11 in components/columns.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/columns.mdx#L11

Try to avoid using first-person plural like 'our'.
</Card>
<Card title="API reference" icon="code">
Explore endpoints, parameters, and examples for your API.
Expand Down
1 change: 0 additions & 1 deletion components/examples.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
title: "Examples"
description: "Display code blocks in the right sidebar on desktop devices"
icon: 'between-horizontal-start'
---

The `<RequestExample>` and `<ResponseExample>` components display code blocks in the right sidebar to create a two-column layout that keeps examples visible while users scroll through your content. These components are designed for API documentation, but they work on all pages.

Check warning on line 6 in components/examples.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/examples.mdx#L6

In general, use active voice instead of passive voice ('are designed').

Common use cases:

Expand All @@ -13,7 +12,7 @@
- Code samples that users reference while following instructions
- Before and after examples in tutorials

On mobile devices, `<RequestExample>` and `<ResponseExample>` components display as regular code blocks and can be scrolled past.

Check warning on line 15 in components/examples.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/examples.mdx#L15

In general, use active voice instead of passive voice ('be scrolled').

<RequestExample>

Expand Down
1 change: 0 additions & 1 deletion components/expandables.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Expandables"
description: "Toggle to display nested properties"
icon: "list-tree"
---

Use expandables to show and hide nested content within response fields. Expandables are particularly useful for displaying complex object properties in API documentation.
Expand Down
1 change: 0 additions & 1 deletion components/fields.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
---
title: "Fields"
description: "Set parameters for your API or SDK references"
icon: "letter-text"
---

Use fields to document API parameters and responses. There are two types of fields: parameter fields and response fields.

## Parameter field

The `<ParamField>` component is used to define parameters for your APIs or SDKs. Adding a `ParamField` automatically adds an [API Playground](/api-playground/overview).

Check warning on line 10 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L10

In general, use active voice instead of passive voice ('is used').

<ParamField path="param" type="string" required>
An example of a parameter field
Expand All @@ -32,16 +31,16 @@

Supports `number`, `string`, `boolean`, `object`.

Arrays can be defined using the `[]` suffix. For example `string[]`.

Check warning on line 34 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L34

In general, use active voice instead of passive voice ('be defined').

</ParamField>

<ParamField body="required" type="boolean">
Indicate whether the parameter is required.

Check warning on line 39 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L39

In general, use active voice instead of passive voice ('is required').
</ParamField>

<ParamField body="deprecated" type="boolean">
Indicate whether the parameter is deprecated.

Check warning on line 43 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L43

In general, use active voice instead of passive voice ('is deprecated').
</ParamField>

<ParamField body="default" type="any">
Expand All @@ -53,7 +52,7 @@
</ParamField>

<ParamField body="children" type="string">
Description of the parameter (Markdown-enabled).

Check warning on line 55 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L55

Use parentheses judiciously.
</ParamField>

## Response field
Expand Down Expand Up @@ -85,17 +84,17 @@
</ResponseField>

<ResponseField name="required" type="boolean">
Indicate whether the response is required.

Check warning on line 87 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L87

In general, use active voice instead of passive voice ('is required').
</ResponseField>

<ResponseField name="deprecated" type="boolean">
Whether a field is deprecated.

Check warning on line 91 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L91

In general, use active voice instead of passive voice ('is deprecated').
</ResponseField>

<ResponseField name="pre" type="string[]">
Labels that are shown before the name of the field.

Check warning on line 95 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L95

In general, use active voice instead of passive voice ('are shown').
</ResponseField>

<ResponseField name="post" type="string[]">
Labels that are shown after the name of the field.

Check warning on line 99 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L99

In general, use active voice instead of passive voice ('are shown').
</ResponseField>
1 change: 0 additions & 1 deletion components/frames.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Frames"
description: "Wrap images or other components in a container"
icon: "frame"
---

Use frames to display images, diagrams, or other visual content with consistent styling and optional captions. Frames center content and provide visual separation from surrounding text.
Expand Down
1 change: 0 additions & 1 deletion components/icons.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Icons"
description: "Use icons from popular icon libraries"
icon: "flag"
---

import IconsRequired from "/snippets/icons-required.mdx";
Expand All @@ -16,7 +15,7 @@

## Inline icons

Icons are placed inline when used within a paragraph.

Check warning on line 18 in components/icons.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/icons.mdx#L18

In general, use active voice instead of passive voice ('are placed').

<Icon icon="flag" iconType="solid" /> The documentation you want, effortlessly.

Expand All @@ -29,7 +28,7 @@
<IconsRequired />

<ResponseField name="color" type="string">
The color of the icon as a hex code (for example, `#FF5733`).

Check warning on line 31 in components/icons.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/icons.mdx#L31

Use parentheses judiciously.
</ResponseField>

<ResponseField name="size" type="number">
Expand Down
1 change: 0 additions & 1 deletion components/mermaid-diagrams.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Mermaid"
description: "Display diagrams using Mermaid"
icon: "waypoints"
---

[Mermaid](https://mermaid.js.org/) lets you build flowcharts, sequence diagrams, Gantt charts, and other diagrams using text and code.
Expand Down
1 change: 0 additions & 1 deletion components/panel.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: 'Panel'
description: 'Specify the content of the right side panel'
icon: 'panel-right'
---

You can use the `<Panel>` component to customize the right side panel of a page with any components that you want.
Expand Down
1 change: 0 additions & 1 deletion components/steps.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Steps"
description: "Sequence content using the Steps component"
icon: "list-todo"
---

import IconsOptional from "/snippets/icons-optional.mdx";
Expand Down
1 change: 0 additions & 1 deletion components/tabs.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Tabs"
description: "Toggle content using the Tabs component"
icon: "panel-top"
---

Use tabs to organize content into multiple panels that users can switch between. You can add any number of tabs and include other components inside each tab.
Expand Down
1 change: 0 additions & 1 deletion components/tooltips.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
title: "Tooltips"
description: "Show a definition when you hover over text"
icon: "message-square"
---

Use tooltips to provide additional context or definitions when a user hovers over a string of text. Tooltips can include optional call-to-action links.

**Example**: <Tooltip tip="Application Programming Interface: a set of protocols for software applications to communicate." cta="Read our API guide" href="/api-reference">API</Tooltip> documentation helps developers understand how to integrate with your service.

Check warning on line 8 in components/tooltips.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/tooltips.mdx#L8

': A' should be in lowercase.

```mdx Tooltip example wrap
<Tooltip tip="Application Programming Interface: a set of protocols for software applications to communicate." cta="Read our API guide" href="/api-reference">API</Tooltip> documentation helps developers understand how to integrate with your service.
Expand Down
3 changes: 1 addition & 2 deletions components/update.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Update"
description: "Keep track of changes and updates"
icon: "list-collapse"
---

Use the `Update` component to display changelog entries, version updates, and release notes with consistent formatting.
Expand All @@ -22,7 +21,7 @@
### Features
- Responsive design
- Anchor for each update
- Generated RSS feed entry for each update

Check warning on line 24 in components/update.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/update.mdx#L24

Spell out 'RSS', if it's unfamiliar to the audience.
</Update>

## How to use
Expand All @@ -33,7 +32,7 @@
</Update>
```

Use multiple `Update` components to create [changelogs](/guides/changelogs).
Use multiple `Update` components to create [changelogs](/create/changelogs).

## Props

Expand Down
1 change: 0 additions & 1 deletion contact-support.mdx
Original file line number Diff line number Diff line change
@@ -1,27 +1,26 @@
---
title: "Contact support"
icon: "circle-help"
description: "We're here to help you get the most out of Mintlify"

Check warning on line 3 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L3

Try to avoid using first-person plural like 'We'.
---

## Ask our docs

Check warning on line 6 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L6

Try to avoid using first-person plural like 'our'.

Select <kbd>Command</kbd> + <kbd>I</kbd> to start a chat with our AI assistant trained on our documentation.

Check warning on line 8 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L8

Try to avoid using first-person plural like 'our'.

Check warning on line 8 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L8

Try to avoid using first-person plural like 'our'.

## Watch video tutorials

Visit our [YouTube](https://www.youtube.com/@GetMintlify/videos) channel for tutorials and guides on using Mintlify.

Check warning on line 12 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L12

Try to avoid using first-person plural like 'our'.

## Message support

Send us a message from your [dashboard](https://dashboard.mintlify.com/) by selecting **Support** in the sidebar.

Check warning on line 16 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L16

Try to avoid using first-person plural like 'us'.

![GIF showing how to access support from the dashboard by selecting the Support button, then selecting an option and typing a question in the support modal that pops up.](https://mintlify.s3.us-west-1.amazonaws.com/mintlify/images/support-flow.gif)

Check warning on line 18 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L18

Spell out 'GIF', if it's unfamiliar to the audience.

<Info>
We aim to respond to all requests within 24 hours, but delays may occur during busy times.

Check warning on line 21 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L21

Try to avoid using first-person plural like 'We'.
</Info>

## Email support

Check warning on line 24 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L24

Use 'email' instead of 'Email'.

If you can't access your dashboard, please email us at <a href="mailto:[email protected]">[email protected]</a>.

Check warning on line 26 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L26

Try to avoid using first-person plural like 'us'.
1 change: 0 additions & 1 deletion settings/broken-links.mdx → create/broken-links.mdx
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
---
title: "Redirects and broken links"
description: "Tools to help prevent invalid links"
icon: "link-2"
---

When you change the path of a file in your docs folder, it also changes the URL path to that page. This may happen when restructuring your docs or changing the sidebar title.

## Broken links

Catch broken links with our CLI. [Install the CLI](/installation) and run the command:

Check warning on line 10 in create/broken-links.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/broken-links.mdx#L10

Try to avoid using first-person plural like 'our'.

Check warning on line 10 in create/broken-links.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/broken-links.mdx#L10

Use 'command-line tool' instead of 'CLI'.

```bash
mint broken-links
```

The CLI identifies any relative links in your docs that don't exist.

Check warning on line 16 in create/broken-links.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/broken-links.mdx#L16

Use 'command-line tool' instead of 'CLI'.

## Redirects

Expand All @@ -29,7 +28,7 @@
]
```

This permanently redirects `/source/path` to `/destination/path` so that you don't lose any previous SEO for the original page.

Check warning on line 31 in create/broken-links.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/broken-links.mdx#L31

Spell out 'SEO', if it's unfamiliar to the audience.

To match a wildcard path, use `*` after a parameter. In this example, `/beta/:slug*` matches `/beta/introduction` and redirects it to `/v2/introduction`.

Expand Down
Loading
Loading