Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion advanced-support.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Advanced support"
description: "Premium support options with faster response times and dedicated customer success."
description: "Get premium support with faster response times, a dedicated customer success manager, and priority assistance for your documentation site."
keywords: ["support", "CSM", "enterprise"]
---

Expand Down
2 changes: 1 addition & 1 deletion agent/customize.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Customize agent behavior"
description: "Configure how the agent handles documentation tasks with AGENTS.md."
description: "Customize agent behavior with an `AGENTS.md` configuration file to control how the agent handles documentation tasks and follows your conventions."
keywords: ["AGENTS.md", "agent configuration", "custom instructions", "agent customization"]
---

Expand Down
2 changes: 1 addition & 1 deletion agent/effective-prompts.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Write effective prompts"
description: "Get better results from the agent with clear, focused prompts."
description: "Write clear, specific prompts to get better results from the agent, with examples of effective instructions and common patterns."
keywords: ["prompts", "agent prompts", "effective prompting", "agent usage"]
---

Expand Down
2 changes: 1 addition & 1 deletion agent/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "What is the agent?"
description: "Automate documentation updates with the agent. Create updates from Slack messages, PRs, or API calls."
description: "Automate documentation updates with the Mintlify agent. Trigger changes from Slack messages, pull requests, Linear issues, or API calls."
keywords: ["automation", "automate", "AI", "autoupdate", "maintenance"]
---

Expand Down
2 changes: 1 addition & 1 deletion agent/linear.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Add the agent to Linear"
description: "Use the agent in Linear to create documentation updates from issues and comments."
description: "Connect the Mintlify agent to Linear to create documentation updates from issues, comments, and project activity."
keywords: ["issue tracking", "project management"]
---

Expand Down
2 changes: 1 addition & 1 deletion agent/notion.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Connect Notion to the agent"
description: "Give the agent access to your Notion workspace to reference pages and databases when updating documentation."
description: "Connect Notion to the Mintlify agent so it can reference your workspace pages and databases as context when creating documentation updates."
keywords: ["Notion", "integration", "knowledge base", "context"]
---

Expand Down
2 changes: 1 addition & 1 deletion agent/slack.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Add the agent to Slack"
description: "Use the agent in Slack to make documentation updates from conversations and capture team knowledge."
description: "Add the Mintlify agent to Slack to create documentation updates from conversations, capture team knowledge, and keep docs in sync."
keywords: ["Slack integration", "Slack bot", "team collaboration", "agent integration", "knowledge capture"]
---

Expand Down
2 changes: 1 addition & 1 deletion agent/use-cases.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Use cases"
description: "Examples of using the agent in your documentation process."
description: "Explore real-world examples of using the Mintlify agent to automate documentation updates, capture knowledge, and maintain accurate docs."
keywords: ["agent workflows", "documentation workflows", "automation examples"]
---

Expand Down
2 changes: 1 addition & 1 deletion agent/workflows.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Workflows"
description: "Automate documentation maintenance with scheduled or event-triggered agent tasks."
description: "Set up automated documentation workflows with scheduled or event-triggered agent tasks."
keywords: ["automation", "automate", "cron", "auto-update"]
tag: "Beta"
---
Expand Down Expand Up @@ -73,7 +73,7 @@

Review all changes since the last changelog update. Draft a new changelog post with any new features, bug fixes, or breaking changes.

Include information about what changed and how it affects users.

Check warning on line 76 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L76

Did you really mean 'informat'?

Do not include any internal-only information or minor changes like bumping package versions or updating documentation.

Expand Down Expand Up @@ -159,7 +159,7 @@
By default, the agent opens a pull request for each workflow run so you can review changes before they go live. Set `automerge: true` to automatically merge the pull request without requiring manual approval. This gives you a record of changes in your repository's pull request history while automating the merge step.

<Note>
Automerge requires the Mintlify GitHub App to have bypass permissions on all rulesets that target your deploy branch, including organization-level and repository-level rulesets. See [Configure automerge](/guides/configure-automerge) for setup instructions.

Check warning on line 162 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L162

Use 'automerge' instead of 'Automerge'.
</Note>

```yaml
Expand Down Expand Up @@ -375,7 +375,7 @@
- If all pages have complete and reasonable metadata, do nothing.
```

### Changelog with notifications

Check warning on line 378 in agent/workflows.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/workflows.mdx#L378

Use 'changelogs?' instead of 'Changelog'.

Runs weekly to generate a changelog and notify your team on Slack when the workflow completes. This example shows how to combine scheduled workflows with Slack notifications.

Expand Down
2 changes: 1 addition & 1 deletion ai-native.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "AI-native documentation"
sidebarTitle: "AI-native"
description: "Learn how AI enhances reading, writing, and discovering your documentation"
description: "Discover how AI-native features enhance reading, writing, and discovering your documentation with the assistant, agent, and MCP server."
keywords: ["AI","assistant","agent","llms.txt","MCP","llms-full.txt"]
---

Expand All @@ -25,7 +25,7 @@

Your site is automatically optimized for AI tools and search engines to help users discover your documentation. All pages send their content 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.

Mintlify hosts `llms.txt` and `skill.md` files for your documentation. These industry-standard files help LLMs respond efficiently with relevant information to user queries and provide a list of capabilities for agents to use, so that users are more successful with your product.

Check warning on line 28 in ai-native.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai-native.mdx#L28

Did you really mean 'LLMs'?

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.

Expand Down
2 changes: 1 addition & 1 deletion ai/assistant.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Assistant"
description: "Add AI-powered chat to your docs that answers questions, cites sources, and generates code examples."
description: "Add an AI-powered chat assistant to your documentation site that answers user questions, cites sources, and generates code examples on demand."
keywords: ["chat", "RAG", "user support", "mulitmodal"]
---

Expand Down
2 changes: 1 addition & 1 deletion ai/discord.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Discord bot"
description: "Add a bot to your Discord server that answers questions based on your documentation."
description: "Set up a Discord bot that answers community questions using your documentation as a knowledge base, with automatic source citations."
keywords: ["Discord", "bot", "Q&A", "customer support"]
---

Expand Down
2 changes: 1 addition & 1 deletion ai/llmstxt.mdx
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
title: "llms.txt"
description: "Automatically generate llms.txt and llms-full.txt files to help AI tools index and understand your documentation."
description: "Automatically generate llms.txt and llms-full.txt files so AI tools like ChatGPT and Claude can index and understand your documentation."
keywords: ["llms.txt", "LLM indexing", "AEO", "GEO", "content discovery"]
---

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

The [llms.txt file](https://llmstxt.org) is an industry standard that helps LLMs index content more efficiently, similar to how a sitemap helps search engines. AI tools can use this file to understand your documentation structure and find content relevant to user queries.

Check warning on line 9 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L9

Did you really mean 'LLMs'?

Mintlify automatically hosts an `llms.txt` file at the root of your project that lists all available pages in your documentation. This file is always up to date and requires zero maintenance. You can optionally add a custom `llms.txt` file to the root of your project.

<Note>
If your site requires authentication, `llms.txt` and `llms-full.txt` also require authentication to view. LLMs and AI tools that cannot authenticate into your site cannot access these files. The files exclude pages that belong to [user groups](/deploy/authentication-setup#control-access-with-groups).

Check warning on line 14 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L14

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

Check warning on line 14 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L14

Did you really mean 'LLMs'?
</Note>

View your `llms.txt` by appending `/llms.txt` to your documentation site's URL. Mintlify also hosts the file at `/.well-known/llms.txt` for compatibility with tools that follow the `.well-known` convention.
Expand All @@ -23,7 +23,7 @@
- `Link: </llms.txt>; rel="llms-txt", </llms-full.txt>; rel="llms-full-txt"`: Follows the standard HTTP `Link` header format for resource discovery.
- `X-Llms-Txt: /llms.txt`: A convenience header for tools that check for `llms.txt` support.

## llms.txt structure

Check warning on line 26 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L26

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

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

Expand All @@ -35,7 +35,7 @@

Each page's description comes from the `description` field in its frontmatter. Descriptions truncate at 300 characters and the first line break. For API reference pages, the description also includes the specification information from the `openapi` or `api` frontmatter field. Pages without a `description` field appear in the `llms.txt` file without a description.

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.

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

Did you really mean 'LLMs'?

```mdx Example llms.txt
# Site title
Expand Down
2 changes: 1 addition & 1 deletion ai/markdown-export.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Markdown export"
description: "Quickly get Markdown versions of pages for AI tools and integrations."
description: "Export clean Markdown versions of your documentation pages for AI tools, LLM integrations, and automated content processing workflows."
keywords: ["markdown", "token efficiency", "AI processing"]
---

Expand Down
2 changes: 1 addition & 1 deletion ai/model-context-protocol.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Model Context Protocol"
description: "Connect your documentation and API endpoints to AI tools with a hosted MCP server."
description: "Connect your documentation and API endpoints to AI tools like Claude and Cursor with a hosted Model Context Protocol (MCP) server."
keywords: ["MCP", "AI tools", "Claude", "Cursor"]
---

Expand Down Expand Up @@ -29,7 +29,7 @@
The MCP search tool supports optional parameters that AI applications use to control and refine search results.

- **`pageSize`**: Number of results to return, between 1 and 50. Defaults to 10.
- **`scoreThreshold`**: Minimum relevance score between 0 and 1. Only returns results at or above this threshold. Use this to filter out low-relevance matches.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L32

Use 'preceding' instead of 'above'.
- **`version`**: Filter results to a specific documentation version. For example, `'v0.7'`. Only returns content tagged with the specified version or content available across all versions.
- **`language`**: Filter results to a specific language code. For example, `'en'`, `'zh'`, or `'es'`. Only returns content in the specified language or content available across all languages.

Expand Down
2 changes: 1 addition & 1 deletion ai/slack-bot.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Slack bot"
description: "Add a bot to your Slack workspace that answers questions based on your documentation."
description: "Set up a Slack bot that answers team questions using your documentation as a knowledge base, with source citations and follow-ups."
keywords: ["bot", "workspace", "Q&A", "Slack", "app"]
---

Expand Down
2 changes: 1 addition & 1 deletion api-playground/adding-sdk-examples.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Add SDK examples"
description: "Display SDK code samples in your API documentation."
description: "Add SDK code samples to your API documentation with autogenerated examples from Speakeasy and Stainless across multiple languages."
keywords: ["x-codeSamples", "SDK examples"]
---

Expand Down
2 changes: 1 addition & 1 deletion api-playground/asyncapi-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "AsyncAPI setup"
description: "Create WebSocket documentation with AsyncAPI specifications."
description: "Set up real-time WebSocket documentation using AsyncAPI specification files to generate interactive channel and message reference pages."
keywords: ["asyncapi", "websocket"]
---

Expand Down
2 changes: 1 addition & 1 deletion api-playground/complex-data-types.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Complex data types"
description: "Describe APIs with flexible schemas, optional properties, and multiple data formats using `oneOf`, `anyOf`, and `allOf` keywords."
description: "Describe APIs with flexible schemas using oneOf, anyOf, and allOf keywords for optional properties, polymorphism, and multiple data formats."

Check warning on line 3 in api-playground/complex-data-types.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/complex-data-types.mdx#L3

Did you really mean 'anyOf'?

Check warning on line 3 in api-playground/complex-data-types.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/complex-data-types.mdx#L3

Did you really mean 'allOf'?
keywords: ["oneOf", "anyOf", "allOf", "schema composition", "polymorphic schemas"]
---

Expand Down
2 changes: 1 addition & 1 deletion api-playground/managing-page-visibility.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Manage page visibility"
description: "Control which API endpoints appear in your documentation navigation."
description: "Control which API endpoints appear in your documentation navigation by hiding, filtering, or organizing autogenerated OpenAPI pages."
keywords: ["x-hidden", "x-excluded", "hide endpoints", "page visibility", "internal endpoints"]
---

Expand All @@ -14,9 +14,9 @@

Common use cases for `x-hidden` are:

- Endpoints you want to document, but not promote.

Check warning on line 17 in api-playground/managing-page-visibility.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/managing-page-visibility.mdx#L17

Use 'endpoints?' instead of 'Endpoints'.
- Pages that you link to from other content.
- Endpoints for specific users.

Check warning on line 19 in api-playground/managing-page-visibility.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/managing-page-visibility.mdx#L19

Use 'endpoints?' instead of 'Endpoints'.

## `x-excluded`

Expand Down
2 changes: 1 addition & 1 deletion api-playground/mdx-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "Create manual API pages"
description: "Create API reference pages manually with MDX files for small APIs, prototypes, or custom documentation needs."
description: "Create API reference pages manually with MDX files when you need full control over layout for small APIs, prototypes, or custom docs."
keywords: ["API documentation", "endpoint documentation"]
---

You can manually define API endpoints in individual MDX pages. This approach is useful for small APIs or prototyping.

## Setup

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/mdx-setup.mdx#L9

Use 'setup' instead of 'Setup'.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/mdx-setup.mdx#L9

'Setup' should use sentence-style capitalization.

<Steps>
<Step title="Configure your API settings">
Expand Down
2 changes: 1 addition & 1 deletion api-playground/multiple-responses.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Multiple responses"
description: "Document multiple response variations for API endpoints."
description: "Document multiple response variations for API endpoints, including success and error cases, with status codes and example payloads."
keywords: ["response examples", "conditional responses", "response variations", "examples property"]
---

Expand Down
2 changes: 1 addition & 1 deletion api-playground/openapi-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "OpenAPI setup"
description: "Generate interactive API documentation from your OpenAPI specification files."
description: "Generate interactive API documentation from OpenAPI specification files with automatic endpoint pages, request builders, and navigation."
keywords: ["OpenAPI", "API specification", "Swagger"]
---

Expand Down
2 changes: 1 addition & 1 deletion api-playground/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Playground"
description: "Let developers test API endpoints directly in your documentation."
description: "Let developers test API endpoints directly in your documentation with an interactive playground that sends real requests and shows responses."
keywords: ["interactive", "API", "endpoint testing", "live API requests", "request builder"]
---

Expand Down
2 changes: 1 addition & 1 deletion api-playground/troubleshooting.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Troubleshooting"
description: "Resolve common issues with API page configuration."
description: "Troubleshoot common issues with API playground configuration, including OpenAPI validation errors, missing endpoints, and auth problems."
keywords: ["API troubleshooting", "invalid OpenAPI", "configuration issues"]
---

Expand Down Expand Up @@ -65,7 +65,7 @@
<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 68 in api-playground/troubleshooting.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/troubleshooting.mdx#L68

In general, use active voice instead of passive voice ('is configured').
requests, then all of these requests fail. To fix this, configure your reverse proxy to
allow `POST` requests to the `/_mintlify/api/request` path.

Expand Down
2 changes: 1 addition & 1 deletion api-playground/websocket-playground.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Playground"
description: "Add interactive WebSocket playgrounds to your documentation so users can test real-time connections directly."
description: "Add interactive WebSocket playgrounds to your documentation so users can test real-time connections, send messages, and view event streams."
asyncapi: "/asyncapi.yaml channelOne"
---
2 changes: 1 addition & 1 deletion changelog.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Product updates"
description: "Stay up to date with Mintlify product updates, new features, improvements, and bug fixes."
description: "Stay up to date with Mintlify product updates, new features, platform improvements, and bug fixes."
rss: true
noindex: true
---
Expand All @@ -23,7 +23,7 @@

Use [inline AI editing](/editor/inline-ai) to generate, rewrite, and restructure content directly in the visual editor. Select text and choose from preset actions or type a custom instruction. Changes stream in as a highlighted diff so you can review before applying.

## Composable `docs.json`

Check warning on line 26 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L26

Did you really mean 'Composable'?

Split large configurations into smaller files using [`$ref` references](/organize/settings#split-configuration-with-%24ref). Each `$ref` points to a separate JSON file resolved at build time.

Expand Down Expand Up @@ -62,7 +62,7 @@
- Fixed padding for tables inside tabs.
- Fixed Frame component hint icon vertical alignment.
- Fixed navigation item badge wrapping.
- Fixed API key being erased during prefill examples.

Check warning on line 65 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L65

In general, use active voice instead of passive voice ('being erased').
- Fixed linked code snippets in cards not being clickable.

</Update>
Expand All @@ -75,7 +75,7 @@

## New contextual menu options

The [contextual menu](/ai/contextual-menu) now includes options for **Google AI Studio**, **Devin**, and **Windsurf**. Users can open any documentation page directly in these tools with the page content preloaded as context.

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 'preloaded'?

## Self-hosted GitLab configuration

Expand All @@ -91,7 +91,7 @@
- Workflow templates updated with improved prompts.
- Workflow run history now viewable from the dashboard with the ability to monitor status and close PRs.
- Slack notifications for workflows now configurable from the dashboard.
- Editor performance improvements: fixed typing latency and persistence blocking in large repositories, virtualized file lists for repositories with many files.

Check warning on line 94 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L94

Did you really mean 'virtualized'?
- Card layout shift on initial page load eliminated.
- Dashboard analytics date-picker responsiveness improved.
- Search now uses a unified endpoint with improved performance and consistency.
Expand All @@ -99,7 +99,7 @@
## Bug fixes

- Fixed Columns component layout regression
- Fixed AsyncAPI enum parameters showing as plain type strings.

Check warning on line 102 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L102

Did you really mean 'enum'?
- Fixed Aspen and Luma theme layout issues.
- Fixed columns component layout breaking across multiple themes.
- Fixed banner-related layout shift in the Luma theme.
Expand Down Expand Up @@ -174,9 +174,9 @@

The assistant now also builds context from the page a user is on and indexes entire OpenAPI specifications.

## Default Vale configuration updates

Check warning on line 177 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L177

'Default Vale configuration updates' should use sentence-style capitalization.

The default [Vale configuration](/deploy/ci#configuration) now parses MDX as MD to avoid fragility with JSX. Previously, Vale returned false positive errors on any JSX inside of MDX components. Now, Vale parses MDX as MD to avoid these errors with tokenIgnores and blockIgnores for MDX and JSX elements that Vale should skip.

Check warning on line 179 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L179

Use 'md' instead of 'MD'.

Check warning on line 179 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L179

Use 'md' instead of 'MD'.

## Improvements

Expand All @@ -185,7 +185,7 @@
- Dashboard layout updated with improved navigation and sidebar access for the editor and settings pages.
- Editor search bar redesigned with better UX for finding and navigating to files.
- Nested drag-and-drop support for lists in the editor.
- Twoslash support for inline TypeScript type information in code blocks.

Check warning on line 188 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L188

Did you really mean 'Twoslash'?
- Deployment history now distinguishes between queued and in-progress states.

## Bug fixes
Expand All @@ -194,7 +194,7 @@
- Fixed cursor jumping when pasting text in the editor.
- Fixed keyboard shortcuts for canceling assistant messages.
- Fixed branch names with underscores not working in the editor.
- Fixed link border colors in callout components.

Check warning on line 197 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L197

Did you really mean 'callout'?
- Fixed mobile zoom behavior for input fields.

</Update>
Expand Down Expand Up @@ -247,7 +247,7 @@

## Improvements

- New search functionality in the web editor makes it easier to find and navigate to files across your documentation.

Check warning on line 250 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L250

Use 'capability' or 'feature' instead of 'functionality'.
- Drag to add table rows and columns directly in the editor for faster table creation and modification.
- The API playground now supports audio response examples, making it easier to document audio-related API endpoints.

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

The [contextual menu](/ai/contextual-menu) now includes an option to add a copyable command to install your docs MCP server.

## `root` in groups

Check warning on line 281 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L281

'in groups' should use sentence-style capitalization.

Navigation groups now support a [`root`](/organize/navigation#root-page) property to set a landing page for the group. Clicking the group header navigates to the root page instead of expanding the group.

Expand All @@ -296,7 +296,7 @@

<Update label="February 6, 2026" tags={["New releases", "Improvements"]} rss={{ title: "Self-serve SSO, viewer role, human/AI traffic toggle, and slash command redesign" }}>

## Self-serve SSO configuration

Check warning on line 299 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L299

'Self-serve SSO configuration' should use sentence-style capitalization.

Enterprise customers can now configure SAML SSO (Okta or Microsoft Entra) directly from the dashboard, including just-in-time (JIT) provisioning, provider switching, and connection removal.

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

<Update label="January 23, 2026" tags={["New releases", "Improvements"]} rss={{ title: "skills.md, audit logs, and markdown export" }}>

## `skill.md` auto-generation

Check warning on line 379 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L379

'auto-generation' should use sentence-style capitalization.

Documentation sites now auto-generate a `skill.md` file based on your API references, guides, and features to give AI agents a comprehensive skills file with context on how to help people use your product. `skill.md` replaces the `install.md` approach with more structured capabilities and wider adoption. If you have a custom `skills.md` file at the root of your documentation repository, it replaces the auto-generated version. See [skill.md](/ai/skillmd) for more information.

Expand All @@ -386,7 +386,7 @@

## Markdown export for agents

Documentation pages now serve raw markdown when the `Accept: text/markdown` header is sent, which enables better AI agent consumption of content.

Check warning on line 389 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L389

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

## Improvements

Expand All @@ -398,7 +398,7 @@

<Update label="January 16, 2026" tags={["New releases", "Improvements"]} rss={{ title: "install.md, live preview in the web editor, and more" }}>

## `install.md` auto-generation

Check warning on line 401 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L401

'auto-generation' should use sentence-style capitalization.
Documentation sites now auto-generate an `install.md` file that aggregates installation-related pages like quickstarts, getting started, installation, and setup guides for AI agents. If you have a custom `install.md` file in your documentation repository, it takes priority over the auto-generated version.

## Web editor improvements
Expand All @@ -408,7 +408,7 @@

## Branch search for Git integrations

Added branch search functionality for GitHub and GitLab integrations so that it is easier to find and switch between deployment branches in the Git settings of your dashboard.

Check warning on line 411 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L411

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

## `mintlify validate` CLI command

Expand All @@ -421,7 +421,7 @@
## Bug fixes

- Fixed API reference base path issues.
- Updated callout colors with a refreshed color scheme.

Check warning on line 424 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L424

Did you really mean 'callout'?
- Fixed images not displaying on initial load after uploading in the editor.
- Fixed code styling within card links.
- Fixed `.md` files incorrectly overwriting `.mdx` files.
Expand Down Expand Up @@ -506,7 +506,7 @@
- Updated [publishing workflow](/editor/publish) to support one-click publishing or creating pull requests.
- Working in the web editor no longer requires you to sign in with GitHub.

## Onboarding improvements

Check warning on line 509 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L509

'Onboarding improvements' should use sentence-style capitalization.

Check warning on line 509 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L509

Use 'onboarding' instead of 'Onboarding'.

- Choose between a Mintlify-hosted documentation repository or using your own repository while signing up.
- Create a documentation site without connecting a GitHub account.
Expand All @@ -525,7 +525,7 @@
<Update label="December 12, 2025" tags={["New releases", "Improvements"]} rss={{ title: "Agent suggestions and Q&A bots" }}>
## Agent suggestions

The agent can now monitor Git repositories and suggest documentation updates. When user-facing code changes are detected, suggestions appear in the agent panel. Suggestions include the relevant pull request and a list of proposed documentation updates. Add suggestions as context for the agent to create pull requests or dismiss them.

Check warning on line 528 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L528

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

## Q&A bots in Slack and Discord

Expand All @@ -541,7 +541,7 @@

- **Insights** renamed to **Analytics** in the dashboard.
- Added ability to delete a deployment from the dashboard.
- The `Tooltip` component has been redesigned with improved styling and now supports an optional `headline` prop for adding a title to your tooltips.

Check warning on line 544 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L544

In general, use active voice instead of passive voice ('been redesigned').
- The `mint a11y` command now supports `--skip-contrast` and `--skip-alt-text` flags, allowing you to run specific accessibility checks in your CI/CD pipeline. Use `--skip-contrast` to check only for missing alt text, or `--skip-alt-text` to check only color contrast ratios.

## Bug fixes
Expand All @@ -550,11 +550,11 @@
- Fixed heading levels 5 and 6 rendering in the web editor.
- Fixed schema page examples display in API reference pages.
- Fixed image upload paths in monorepo setups.
- Fixed an issue where the incorrect request payload value was being selected first in the API playground.

Check warning on line 553 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L553

In general, use active voice instead of passive voice ('being selected').
- Removed file extensions from default image titles when uploading.
- Fixed double underline styling on banner links.
- Fixed loading states and date range values for analytics page.
- Folders in the web editor now properly maintain their open/closed state when other folders are opened or closed.

Check warning on line 557 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L557

In general, use active voice instead of passive voice ('are opened').
- Fixed long API page titles overflowing instead of wrapping.

</Update>
Expand All @@ -576,7 +576,7 @@

You can now display "last modified" timestamps on all pages in your documentation. Enable this feature by setting the [`timestamp`](/organize/settings-seo#metadata) flag in your `docs.json` settings.

When enabled, each page will automatically show when it was last updated, helping readers understand how current the content is.

Check warning on line 579 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L579

Avoid using 'will'.

</Update>

Expand All @@ -592,8 +592,8 @@

## Assistant improvements

- Fixed assistant submission to prevent empty messages from being sent.

Check warning on line 595 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L595

In general, use active voice instead of passive voice ('being sent').
- Fixed accidental message submission during IME composition (for languages like Japanese, Chinese, Korean).

Check warning on line 596 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L596

Spell out 'IME', if it's unfamiliar to the audience.
- Better behavior when adding code snippets to assistant.

## Bug fixes and reliability
Expand All @@ -601,7 +601,7 @@
- Fixed handling of complex Mermaid diagrams.
- Fixed hash handling for URLs and table of contents to properly highlight the active page when accessing the root path with an index page.
- Added ability to disable 404 page recommendations via configuration.
- Fixed a bug in the API playground where boolean `false` and numeric `0` values in query parameters would be filtered out and not appear in the generated API request.

Check warning on line 604 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L604

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

</Update>

Expand All @@ -617,7 +617,7 @@
<Update label="December 1, 2025" tags={["New releases"]} rss={{ title: ".mintignore support", description: "Exclude files and directories from your published documentation" }}>
## .mintignore support

- Added `.mintignore` file support to exclude specific files and directories from being processed and published to your documentation site.

Check warning on line 620 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L620

In general, use active voice instead of passive voice ('being processed').
- Uses the same pattern syntax as `.gitignore` for familiar configuration.
- Excluded files don't appear in published docs, aren't indexed for search, and aren't accessible to visitors.

Expand All @@ -638,7 +638,7 @@
- Fixed issue where response section would disappear when switching between endpoints with different response codes. The playground now properly resets to the first available response code when navigating to a new endpoint.
- Fixed double "Authorization" header display in HTTP Basic authentication schemes. The authentication section now shows a cleaner interface with proper field labels and descriptions.
- Improved handling of `oneOf` schemas in nested objects and arrays. Complex API schemas with multiple type options now render correctly as dropdowns instead of tabs in appropriate contexts.
- Fixed missing path parameters that were defined at the endpoint level in OpenAPI specs. Parameters specified above individual operations are now properly included in both the main page and playground.

Check warning on line 641 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L641

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

Check warning on line 641 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L641

Use 'preceding' instead of 'above'.
- Enhanced response example generation to include all required properties, even when examples only specify some fields. This ensures response examples are complete and accurate.
- Fixed missing prefill examples in object arrays. Array items with example data now properly populate in the playground with correct indexing.
- Improved description padding and spacing throughout the API playground for better readability and visual consistency.
Expand All @@ -649,7 +649,7 @@

## CLI improvements

- Added error message for users running `mint dev` on Node.js versions below 20.17. Users are guided to upgrade to an LTS version.

Check warning on line 652 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L652

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

</Update>

Expand All @@ -657,7 +657,7 @@
## New features

- **Badge component**: New <Badge color="green">Badge</Badge> component for displaying status indicators, labels, and tags
- **Custom Shiki languages**: Add support for custom programming languages in code blocks through `docs.json` configuration, enabling syntax highlighting for domain-specific languages

Check warning on line 660 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L660

Did you really mean 'Shiki'?
- **Clarity analytics integration**: Microsoft Clarity is now available as an analytics integration for session recording and heatmap tracking

## API playground improvements
Expand All @@ -668,14 +668,14 @@
- Security inputs defined at the operation level in OpenAPI specs now properly override top-level security definitions
- Fixed issue where header inputs marked as security parameters were incorrectly included in generated code examples
- Improved handling of `deepObject` style parameters in API field displays
- Better error messages when invalid URLs are provided in API configurations

Check warning on line 671 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L671

In general, use active voice instead of passive voice ('are provided').
- Improved UI for API playground with better spacing, layout, and loading

## Navigation and UI enhancements

- Tab hover indicators now have improved styling for better visual feedback
- Long words now wrap properly to prevent horizontal scrolling
- Step component now handles cases where no step title is provided

Check warning on line 678 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L678

In general, use active voice instead of passive voice ('is provided').
- Logo section spacing improved with better padding
- Fixed heading IDs to properly handle question marks and special characters for anchor links
- Icon component now accepts `className` prop for custom styling
Expand All @@ -690,8 +690,8 @@

## Component and styling enhancements

- Images can now be zoomed with improved overlay styling for both light and dark modes

Check warning on line 693 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L693

In general, use active voice instead of passive voice ('be zoomed').
- Fixed keyboard shortcut styles inside callouts for dark mode

Check warning on line 694 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L694

Did you really mean 'callouts'?
- Improved OG image generation with Google Fonts support and better truncation logic
- Improved UI for tables with better alignment, spacing, and readability
- Fixed scroll behavior for tables inside tabs and steps inside tabs
Expand All @@ -699,7 +699,7 @@

## Performance and infrastructure

- Shiki themes are now lazy loaded for improved initial page load performance

Check warning on line 702 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L702

Did you really mean 'Shiki'?
- Reduced navigation lag by optimizing prefetching behavior

## Bug fixes and reliability
Expand All @@ -717,22 +717,22 @@
<Update label="October 31, 2025" tags={["Improvements"]} rss={{ title: "Weekly Updates", description: "API playground enhancements, table improvements, performance optimizations, and bug fixes" }}>
## Assistant improvements

- **Starter questions for assistant are here! You can add your own within the dashboard at [Assistant --> Settings](https://dashboard.mintlify.com/mintlify/mintlify/products/assistant/settings)**

Check warning on line 720 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L720

Don't use exclamation points in text.
- Assistant insights quality has been improved with default spam protection for abusive keywords and JSON queries.

Check warning on line 721 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L721

In general, use active voice instead of passive voice ('been improved').

## API playground improvements

- The API playground now automatically fills in default values for parameters, which saves time when testing endpoints.
- Issues with `allOf`, `oneOf`, and nested object schemas that previously caused rendering problems or incorrect field displays have been fixed, and complex API schemas now render correctly with all fields visible and properly structured.

Check warning on line 726 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L726

In general, use active voice instead of passive voice ('been fixed').
- Enum and nullable field types now display accurate labels in the playground, which makes it clearer what values are accepted and whether fields are optional.

Check warning on line 727 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L727

Did you really mean 'Enum'?

Check warning on line 727 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L727

In general, use active voice instead of passive voice ('are accepted').
- When working with nested objects in API requests, the playground now shows proper descriptive labels for each field instead of generic placeholders, which makes it easier to understand what data to provide.
- Enum const tables and API field displays now render with improved formatting and alignment, which makes it easier to scan available options and understand field requirements.

Check warning on line 729 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L729

Did you really mean 'Enum'?
- API playground modals now display rich MDX-formatted descriptions at the top, which gives better context for endpoints with formatted text, links, and code examples.

## Analytics changes

- Deferred analytics loading: PostHog and LogRocket now load after documentation content, which improves initial page load times and Core Web Vitals scores without affecting analytics data.
- Conditional session recording: PostHog session recording can now be enabled conditionally based on user properties or page context for more control over when recordings happen.

Check warning on line 735 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L735

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

## Visual improvements

Expand All @@ -756,7 +756,7 @@
## Insights improvements

- Improved insights page with fixed date selectors for "today" and "yesterday"
- Enhanced feedback table with improved search functionality

Check warning on line 759 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L759

Use 'capability' or 'feature' instead of 'functionality'.
- Added loading state for categories table

## Assistant improvements
Expand Down Expand Up @@ -819,7 +819,7 @@
- Added feature flag support for new API reference page design
- Improved OpenAPI schema graph utilities to handle compositions properly
- Added endpoint type to operation data for better API documentation
- Fixed API playground description rendering when enum and table are in Markdown

Check warning on line 822 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L822

Did you really mean 'enum'?
- Moved rendering of descriptions in API playground for better layout

## Bug fixes and reliability
Expand All @@ -841,7 +841,7 @@
<Update label="October 11, 2025" tags={["Improvements"]} rss={{ title: "Weekly Updates", description: "API playground improvements, analytics enhancements, web editor updates, and bug fixes" }}>
## Assistant and Agent AI features

- Added list_pull_requests and list_commits tools for agent such that it can document a date range of PRs or multiple PRs at once

Check warning on line 844 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L844

Did you really mean 'list_pull_requests'?

Check warning on line 844 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L844

Did you really mean 'list_commits'?
- Upgraded agent and assistant to Claude Sonnet 4.5
- Improved assistant search to query docs in parallel for faster assistant responses
- Fixed conversation length counting to exclude tool calls
Expand Down Expand Up @@ -873,14 +873,14 @@
## Bug fixes and reliability

- Fixed duplicate base paths and links in 404 recommended pages
- Auto-populated og:url tag with appropriate canonical URL

Check warning on line 876 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L876

Use 'OG' instead of 'og'.

Check warning on line 876 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L876

Use 'URL' instead of 'url'.

Check warning on line 876 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L876

Use 'URL' instead of 'url'.
- Added canonical tag for better SEO
- Fixed code block overscroll issues
- Made search engines ignore preview deployments for SEO purposes
- Fixed referrer tracking to use domain instead of full URL
- Fixed images always becoming MDX block elements (kept inline images inline)
- Removed comments in raw markdown pages such that you can use TODO comments without them leaking to users

Check warning on line 882 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L882

Use 'todo' instead of 'TODO'.
- Fixed directory reading support for read_external_files

Check warning on line 883 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L883

Did you really mean 'read_external_files'?

## Component and styling

Expand All @@ -896,13 +896,13 @@
- **Accessibility CLI command**: Run `mint a11y` to test your docs for accessibility issues
- **Video responses in API playground**: API playground now supports displaying video response types
- **API playground prefill**: New option to prefill API playground examples for faster testing
- **Unauthenticated feedback**: For sites using partial authentication, users can now submit feedback without being authenticated

Check warning on line 899 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L899

In general, use active voice instead of passive voice ('being authenticated').
- **Shiki theme support**: Shiki themes are now supported for code block styling

Check warning on line 900 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L900

Did you really mean 'Shiki'?

Check warning on line 900 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L900

Did you really mean 'Shiki'?
- **Twoslash for code blocks**: TypeScript and JavaScript code blocks now support Twoslash for inline type information

Check warning on line 901 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L901

Did you really mean 'Twoslash'?

Check warning on line 901 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L901

Did you really mean 'Twoslash'?

## Accessibility improvements

- Added comprehensive ARIA attributes across components for better screen reader support

Check warning on line 905 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L905

Spell out 'ARIA', if it's unfamiliar to the audience.
- New "skip to main content" button for keyboard navigation
- Arrow key navigation support in tab components
- Enhanced tooltips, nested lists, and code group accessibility
Expand Down Expand Up @@ -935,7 +935,7 @@

- 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 938 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L938

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

## UI and user experience improvements

Expand Down Expand Up @@ -971,7 +971,7 @@
- Fixed GitLab integration issues with larger repositories
- Improved dashboard loading performance with optimized deployment queries
- Fixed SVG path rendering issues in documentation
- Fixed keyboard navigation in search and chat functionality

Check warning on line 974 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L974

Use 'capability' or 'feature' instead of 'functionality'.
</Update>

<Update label="September 13, 2025" tags={["New releases", "Improvements"]} rss={{ title: "Weekly Updates", description: "AI 404 suggestions, assistant web search with external sources, security enhancement, and reliability fixes" }}>
Expand All @@ -991,10 +991,10 @@

## Web editor and deployments

- Security enhancement added to editor such that only users with `write permissions` for the connected git hosting repository can make changes

Check warning on line 994 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L994

Use 'Git' instead of 'git'.
- 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 997 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L997

Avoid using 'will'.
- Fixed a bug where copying a page from the context menu was not working on safari

## API playground and navigation
Expand All @@ -1007,7 +1007,7 @@
- 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
- Fixed a bug where youtube embeds would flash in and out on load
- 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 1010 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1010

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 Down Expand Up @@ -1036,34 +1036,34 @@
- 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 1039 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1039

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

## 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 1044 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1044

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 1048 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1048

Did you really mean 'cdnjs'?

Check warning on line 1048 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1048

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

<Update label="August 23, 2025" tags={["Improvements"]} rss={{ title: "Weekly Updates", description: "Image layout fixes, auth enhancements, mobile nav improvements, and web editor stability" }}>
## 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 1055 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1055

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 1060 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1060

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 subpaths, 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 1066 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1066

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 @@ -1075,7 +1075,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 1078 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1078

Use 'capability' or 'feature' instead of 'functionality'.
</Update>

<Update label="August 16, 2025" tags={["Improvements"]} rss={{ title: "Weekly Updates", description: "Performance optimizations, LLM integrations, web editor polish, and API playground enhancements" }}>
Expand All @@ -1091,7 +1091,7 @@

- 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 1094 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1094

Use 'MDX' instead of 'mdx'.
- 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 @@ -1102,7 +1102,7 @@
- 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

## Analytics and LLM integrations

Check warning on line 1105 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1105

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

- 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
- Added [Hightouch analytics integration](/integrations/analytics/hightouch)
Expand Down Expand Up @@ -1138,7 +1138,7 @@

- 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 1141 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1141

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
- Auto-strip `https://` from URLs in OAuth/JWT auth configuration to prevent misconfiguration

Expand All @@ -1156,9 +1156,9 @@

## 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 1159 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1159

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 1160 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1160

Use 'email' instead of 'Email'.
- Both custom domains and subdomains in Redis for a performance improvement on navigation load times (~50ms latency reduction)

Check warning on line 1161 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1161

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`
Expand All @@ -1168,8 +1168,8 @@
- CLI bugfixes for windows and pnpm, plus CI tests to prevent regressions
- Improved error logging output—a quality of life upgrade for our engineering team when debugging
- 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 1171 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1171

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 1172 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1172

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
</Update>
Expand All @@ -1184,7 +1184,7 @@

## API playground enhancements

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

Check warning on line 1187 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1187

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 @@ -1199,7 +1199,7 @@

- Made search feel more crisp and accurate by aborting debounced requests as you type
- Resource provisions for a new CDN - expect image asset and page load times to improve soon
- Fixed bugs for rendering complex Mermaid diagrams like GANTT charts

Check warning on line 1202 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1202

Use 'Gantt' instead of 'GANTT'.

Check warning on line 1202 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1202

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

## Technical improvements
Expand Down Expand Up @@ -1242,7 +1242,7 @@

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

## Subscribable changelogs

Check warning on line 1245 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1245

Did you really mean 'Subscribable'?

- Automatically generate an RSS feed from changelog pages
- Integrate RSS-enabled updates with Slack, email, and other tools
Expand All @@ -1266,10 +1266,10 @@
</Update>

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

Check warning on line 1269 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1269

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

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

Check warning on line 1272 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1272

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

Expand All @@ -1285,14 +1285,14 @@

- 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 1288 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1288

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

Check warning on line 1291 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1291

Use 'diffs?' instead of 'Diff'.
- 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 1295 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1295

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

<Frame>
![AI Translations graphic](/images/changelog/translations.png)
Expand Down Expand Up @@ -1326,10 +1326,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 1329 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1329

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 1332 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1332

Did you really mean 'callouts'?

Check warning on line 1332 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1332

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

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

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

## CI Checks

Check warning on line 1359 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1359

'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](deploy/ci).

## .md support for LLMs

Check warning on line 1363 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1363

'.md support for LLMs' should use sentence-style capitalization.

Check warning on line 1363 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1363

Did you really mean '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 1365 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1365

Did you really mean 'LLMs'?

## More Themes

Check warning on line 1367 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1367

'More Themes' should use sentence-style capitalization.

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

- [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](organize/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 1384 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1384

Avoid using 'will'.
</Update>

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

Check warning on line 1388 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1388

'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
Expand All @@ -1396,7 +1396,7 @@

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 1399 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1399

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

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

Expand All @@ -1419,18 +1419,18 @@
</Update>

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

Check warning on line 1422 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1422

'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 1429 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1429

'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](/deploy/gitlab) to get started.

## Web Editor

Check warning on line 1433 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1433

'Web Editor' should use sentence-style capitalization.

<Frame>
![Web Editor](/images/changelog/webeditor.jpg)
Expand All @@ -1439,7 +1439,7 @@

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

## /llms.txt support

Check warning on line 1442 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1442

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

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

## 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 1451 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1451

Avoid using 'will'.

### Quality Improvements

Expand All @@ -1457,21 +1457,21 @@
</Update>

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

Check warning on line 1460 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1460

Use 'changelogs?' instead of 'Changelogs'.

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

<Frame>
![Changelog](/images/changelog/changelog.jpg)

Check warning on line 1465 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1465

Use 'changelogs?' instead of 'Changelog'.
</Frame>
## Code Line Highlighting

Check warning on line 1467 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1467

'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,4,5}
const greeting = "Hello, World!";

Check warning on line 1472 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1472

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

Check warning on line 1474 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1474

Use semicolons judiciously.
}
sayHello();
```
Expand Down
2 changes: 1 addition & 1 deletion components/accordions.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Accordions"
description: "Use accordions to show and hide content sections, organize information, and enable progressive disclosure in your documentation."
description: "Use the accordion component to show and hide content sections, organize related information, and enable progressive disclosure in your docs."
keywords: ["accordions", "collapsible content", "expandable sections", "progressive disclosure"]
---

Expand Down
2 changes: 1 addition & 1 deletion components/badge.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Badge"
description: "Use badges to highlight status, labels, or metadata inline or standalone."
description: "Use the badge component to highlight status indicators, version labels, or metadata inline with customizable colors and hover tooltips."
keywords: ["badge", "label", "tag", "status", "indicator"]
---

Expand Down
2 changes: 1 addition & 1 deletion components/banner.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Banner"
description: "Add a banner to display important site-wide announcements and notifications."
description: "Add a dismissible banner at the top of your documentation site to display important announcements, release notes, or notifications."
keywords: ["banner", "announcements", "site-wide"]
---

Expand Down
2 changes: 1 addition & 1 deletion components/callouts.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "Callouts"

Check warning on line 2 in components/callouts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/callouts.mdx#L2

Did you really mean 'Callouts'?
description: "Use callouts to style and emphasize important content."
description: "Use callout components to highlight important information, warnings, and tips in your documentation."

Check warning on line 3 in components/callouts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/callouts.mdx#L3

Did you really mean 'callout'?
keywords: ["callouts", "notes", "warnings", "info boxes", "tips", "emphasis", "highlight"]
---

import IconsOptional from "/snippets/icons-optional.mdx";

Style callouts as Note, Warning, Info, Tip, Check, Danger, or create your own callout:

Check warning on line 9 in components/callouts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/callouts.mdx#L9

Did you really mean 'callouts'?

Check warning on line 9 in components/callouts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/callouts.mdx#L9

Did you really mean 'callout'?

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

Expand Down Expand Up @@ -38,24 +38,24 @@
<Check>This brings us a checked status</Check>
```

<Danger>This is a danger callout</Danger>

Check warning on line 41 in components/callouts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/callouts.mdx#L41

Did you really mean 'callout'?

```mdx
<Danger>This is a danger callout</Danger>
```

<Callout icon="key" color="#FFC107" iconType="regular"> This is a custom callout</Callout>

Check warning on line 47 in components/callouts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/callouts.mdx#L47

Did you really mean 'callout'?

```mdx wrap
<Callout icon="key" color="#FFC107" iconType="regular">This is a custom callout</Callout>
```

## Custom callout properties

Check warning on line 53 in components/callouts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/callouts.mdx#L53

Did you really mean 'callout'?

The generic `Callout` component supports custom icons and colors. The typed callouts (`Note`, `Warning`, `Info`, `Tip`, `Check`, `Danger`) use preset icons and colors and only accept `children`.

Check warning on line 55 in components/callouts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/callouts.mdx#L55

Did you really mean 'callouts'?

<IconsOptional />

<ResponseField name="color" type="string">
Custom color as a hex code (for example, `#FFC107`). Sets the border, background tint, and text color of the callout.

Check warning on line 60 in components/callouts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/callouts.mdx#L60

Did you really mean 'callout'?
</ResponseField>
2 changes: 1 addition & 1 deletion components/cards.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Cards"
description: "Highlight main points or links with customizable layouts and icons."
description: "Use card components to highlight key points, create navigation links, and organize content with icons and customizable layouts."
keywords: ["cards", "visual containers"]
---

Expand Down
2 changes: 1 addition & 1 deletion components/code-groups.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Code groups"
description: "Display multiple code examples in a tabbed interface to compare implementations across different languages."
description: "Use code groups to display multiple code examples in a tabbed interface and compare implementations across different languages."
keywords: ["code groups", "tabbed code", "multi-language examples", "CodeGroup"]
---

Expand Down
2 changes: 1 addition & 1 deletion components/color.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Color"
description: "Display color palettes with click-to-copy capability."
description: "Display color swatches with hex values and click-to-copy capability using the color component for design system and branding documentation."
keywords: ["color", "palette", "colors", "design system", "hex", "rgb", "rgba", "hsl", "oklch"]
---

Expand All @@ -22,7 +22,7 @@
<Color.Item name="blue-500" value="#3B82F6" />
<Color.Item name="blue-600" value="#2563EB" />
<Color.Item name="blue-700" value="#1D4ED8" />
<Color.Item name="blue-800" value="#1E40AF" />

Check warning on line 25 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L25

'r.I' should have one space.
</Color>
```

Expand All @@ -44,7 +44,7 @@

```mdx Table example
<Color variant="table">
<Color.Row title="Primary">

Check warning on line 47 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L47

'Color.Row' should use sentence-style capitalization.

Check warning on line 47 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L47

'r.R' should have one space.
<Color.Item name="primary-500" value="#3B82F6" />
<Color.Item name="primary-600" value="#2563EB" />
<Color.Item name="primary-700" value="#1D4ED8" />
Expand All @@ -58,7 +58,7 @@

## Color formats

The component supports all CSS color formats including hex, rgb, rgba, hsl, and oklch.

Check warning on line 61 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L61

Did you really mean 'rgb'?

Check warning on line 61 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L61

Did you really mean 'rgba'?

Check warning on line 61 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L61

Did you really mean 'hsl'?

Check warning on line 61 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L61

Did you really mean 'oklch'?

<Color variant="compact">
<Color.Item name="hex" value="#FF5733" />
Expand Down
2 changes: 1 addition & 1 deletion components/columns.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Columns'
description: "Arrange cards and other components in a responsive grid layout with customizable column counts."
description: "Arrange cards and other components in a responsive grid layout with the columns component."
keywords: ['card groups', 'grid layout', 'multi-column layout']
---

Expand Down
2 changes: 1 addition & 1 deletion components/examples.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Examples"
description: "Display code blocks in the right sidebar on desktop devices"
description: "Display code examples in the right sidebar panel on desktop devices to show request and response samples alongside API documentation."
keywords: ["RequestExample", "ResponseExample", "code examples", "request-response"]
---

Expand Down
2 changes: 1 addition & 1 deletion components/expandables.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Expandables"

Check warning on line 2 in components/expandables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/expandables.mdx#L2

Use 'expandables' instead of 'Expandables'.
description: "Toggle expandable sections to show and hide nested object properties in API documentation and response fields."
description: "Use the expandable component to toggle nested object properties in API documentation, showing child fields for request and response objects."
keywords: ["expandables", "nested properties", "expandable fields", "toggle content"]
---

Expand Down
2 changes: 1 addition & 1 deletion components/fields.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Fields"
description: "Document API request and response parameters with type information."
description: "Document API request and response parameters with types, defaults, and validation requirements."
keywords: ["ParamField", "ResponseField", "request parameters", "response documentation"]
---

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

## 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 11 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L11

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 +32,16 @@

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

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

Check warning on line 35 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L35

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 40 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L40

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 44 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L44

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

<ParamField body="default" type="any">
Expand Down Expand Up @@ -85,17 +85,17 @@
</ResponseField>

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

Check warning on line 88 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L88

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 92 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L92

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 96 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L96

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 100 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L100

In general, use active voice instead of passive voice ('are shown').
</ResponseField>
2 changes: 1 addition & 1 deletion components/frames.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Frames"
description: "Add visual emphasis with styled frames around images and other components."
description: "Wrap images, videos, and other components with the frame component to add styled borders, captions, and visual emphasis to your content."
keywords: ["image frames", "visual emphasis", "captions", "border"]
---

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

## Hints

Add text that precedes the frame using the optional `hint` prop. Hints appear above the frame.

Check warning on line 35 in components/frames.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/frames.mdx#L35

Use 'preceding' instead of 'above'.

<Frame hint="If you plan to visit Yosemite National Park, secure your permits before you go." caption="Yosemite National Park is visited by over 3.5 million people every year.">
<img src="https://mintlify-assets.b-cdn.net/yellowstone.jpeg" alt="Photograph of a lake surrounded by trees with mountains in the distance in Yellowstone National Park." />
Expand Down
2 changes: 1 addition & 1 deletion components/icons.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Icons"
description: "Use icons from popular libraries, external URLs, or files in your project."
description: "Add icons from Font Awesome, Lucide, Tabler, or custom sources to your documentation pages using the icon component with size and color options."
keywords: ["Font Awesome", "Lucide", "Tabler", "SVGs"]
---

Expand All @@ -16,7 +16,7 @@

## Inline icons

Icons are placed inline when used within a sentence, paragraph, or heading. <Icon icon="flag" iconType="solid" /> Use icons for decoration or to add visual emphasis.

Check warning on line 19 in components/icons.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/icons.mdx#L19

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

```markdown Inline icon example
Icons are placed inline when used within a sentence, paragraph, or heading. <Icon icon="flag" iconType="solid" /> Use icons for decoration or to add visual emphasis.
Expand Down
2 changes: 1 addition & 1 deletion components/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Overview"
description: "Component library for layout, emphasis, API documentation, and navigation."
description: "Browse the full Mintlify component library for layout, emphasis, API documentation, and navigation elements available in your MDX pages."
keywords:
["MDX components", "documentation components", "UI components", "components"]
---
Expand Down Expand Up @@ -111,7 +111,7 @@

<Card
title="Mermaid diagrams"
icon="git-branch"

Check warning on line 114 in components/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/index.mdx#L114

Use 'Git' instead of 'git'.
href="/components/mermaid-diagrams"
>
Create flowcharts, sequence diagrams, and more.
Expand Down
2 changes: 1 addition & 1 deletion components/mermaid-diagrams.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Mermaid"
description: "Create flowcharts, diagrams, and visualizations with Mermaid syntax."
description: "Create flowcharts, sequence diagrams, and other visualizations in your documentation using Mermaid syntax with automatic rendering."
keywords: ["Mermaid", "flowcharts", "diagrams"]
---

Expand Down
2 changes: 1 addition & 1 deletion components/panel.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Panel"
description: "Customize the content of the right side panel on a page."
description: "Customize the right side panel content on documentation pages to display supplementary information, examples, or navigation elements."
keywords: ["sidebar"]
---

Expand Down
2 changes: 1 addition & 1 deletion components/prompt.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Prompt"
description: "Display pre-built AI prompts with copy and Cursor integration actions."
description: "Display pre-built AI prompts with one-click copy and Cursor integration buttons so users can quickly use prompts in their AI tools."
keywords: ["prompt", "AI", "cursor", "copy", "prompt card"]
---

Expand Down
2 changes: 1 addition & 1 deletion components/responses.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Response fields"
description: "Document API response fields with type information, descriptions, and required/optional indicators."
description: "Document API response fields with type annotations, descriptions, and required/optional indicators."
keywords: ["API output", "return values", "response structure"]
---

Expand Down Expand Up @@ -35,15 +35,15 @@
</ResponseField>

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

Check warning on line 38 in components/responses.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/responses.mdx#L38

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 42 in components/responses.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/responses.mdx#L42

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 46 in components/responses.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/responses.mdx#L46

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

<RequestExample>
Expand Down
2 changes: 1 addition & 1 deletion components/steps.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Steps"
description: "Create numbered step-by-step procedures with visual indicators to guide users through sequential tasks and tutorials."
description: "Create numbered step-by-step procedures to guide users through sequential tasks, tutorials, and setup workflows."
keywords: ["sequence", "numbered steps", "procedures", "tutorial steps"]
---

Expand Down
2 changes: 1 addition & 1 deletion components/tabs.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Tabs"
description: "Organize content with tabs to show different options or versions."
description: "Use tabs to organize content into switchable panels for showing different options, versions, or language examples."
keywords: ["tabbed content", "content panels", "switchable content"]
---

Expand Down
2 changes: 1 addition & 1 deletion components/tiles.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Tiles"
description: "Display visual previews with titles and descriptions in a grid layout."
description: "Use the tiles component to display visual previews with image thumbnails, titles, and descriptions in a responsive grid layout for your docs."
keywords: ["tiles", "visual preview", "grid", "showcase"]
---

Expand Down Expand Up @@ -57,7 +57,7 @@
## Properties

<ResponseField name="href" type="string" required>
URL to navigate to when the tile is clicked.

Check warning on line 60 in components/tiles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/tiles.mdx#L60

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

<ResponseField name="title" type="string">
Expand Down
2 changes: 1 addition & 1 deletion components/tooltips.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Tooltips"
description: "Add contextual help with hover tooltips for terms and concepts."
description: "Add tooltips to display contextual definitions and explanations when users hover over terms, abbreviations, or concepts."
keywords: ["tooltips", "hover help", "contextual information", "explanatory", "definitions"]
---

Expand All @@ -19,7 +19,7 @@
</ResponseField>

<ResponseField name="headline" type="string">
Text displayed above the `tip` text.

Check warning on line 22 in components/tooltips.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/tooltips.mdx#L22

Use 'preceding' instead of 'above'.
</ResponseField>

<ResponseField name="cta" type="string">
Expand Down
2 changes: 1 addition & 1 deletion components/tree.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Tree"
description: "Use tree components to display hierarchical file and folder structures."
description: "Use the tree component to display hierarchical file and folder structures with collapsible nodes and syntax highlighting for path names."
keywords: ["tree", "file tree", "folder structure", "hierarchical navigation", "file system"]
---

Expand All @@ -27,9 +27,9 @@
<Tree.Folder name="app" defaultOpen>
<Tree.File name="layout.tsx" />
<Tree.File name="page.tsx" />
<Tree.File name="global.css" />

Check warning on line 30 in components/tree.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/tree.mdx#L30

'Tree.File' should use sentence-style capitalization.

Check warning on line 30 in components/tree.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/tree.mdx#L30

'e.F' should have one space.
</Tree.Folder>
<Tree.Folder name="lib">

Check warning on line 32 in components/tree.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/tree.mdx#L32

'Tree.Folder' should use sentence-style capitalization.

Check warning on line 32 in components/tree.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/tree.mdx#L32

'e.F' should have one space.
<Tree.File name="utils.ts" />
<Tree.File name="db.ts" />
</Tree.Folder>
Expand Down Expand Up @@ -104,11 +104,11 @@
</ResponseField>

<ResponseField name="defaultOpen" type="boolean" default="false">
Whether the folder is expanded by default.

Check warning on line 107 in components/tree.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/tree.mdx#L107

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

<ResponseField name="openable" type="boolean" default="true">
Whether the folder can be opened and closed. Set to false for non-interactive folders.

Check warning on line 111 in components/tree.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/tree.mdx#L111

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

### Tree.File
Expand Down
Loading
Loading