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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion ai/slack-bot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
keywords: ["bot", "workspace", "Q&A", "Slack", "app"]
---

<Snippet file="snippets/components/rainbow-text.mdx" />

<Info>
The Slack app is available for [Pro and Custom plans](https://mintlify.com/pricing?ref=slack-app) with access to the assistant.
</Info>
Expand All @@ -19,10 +21,10 @@
## Set up the Slack app

<Note>
You can only install the Slack app once per workspace. If you have multiple Mintlify deployments, you can only connect one deployment at a time to a workspace. You must disconnect the app from one deployment before connecting it to another.
You can only install the Slack app once per workspace. If you have multiple Mintlify deployments, you can only connect one <RainbowText>deployment</RainbowText> at a time to a workspace. You must disconnect the app from one <RainbowText>deployment</RainbowText> before connecting it to another.
</Note>

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

Check warning on line 27 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L27

Use 'administrator' instead of 'admin'.

1. Navigate to the [Assistant](https://dashboard.mintlify.com/products/assistant) page in your dashboard.
1. In the Slack card, click **Configure**. This opens Slack.
Expand All @@ -31,7 +33,7 @@
<img src="/images/assistant/connected-apps-dark.png" alt="The connected apps section of the assistant page." className="hidden dark:block" />
</Frame>
1. Follow the Slack prompts to add the app to your workspace.
1. Mention the bot to add it to a channel. The bot's default name is `@mintlify-assistant`.

Check warning on line 36 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L36

Did you really mean 'bot's'?

## Create an `#ask-ai` channel

Expand Down
4 changes: 3 additions & 1 deletion api/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
keywords: ["REST API", "endpoints", "API keys"]
---

<Snippet file="snippets/components/rainbow-text.mdx" />

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

Check warning on line 9 in api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/introduction.mdx#L9

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

## Endpoints

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

Check warning on line 18 in api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/introduction.mdx#L18

Use 'app' instead of 'application'.
- [Search documentation](/api/assistant/search): Search through your documentation.
- [Get user feedback](/api/analytics/feedback): Export user feedback from your documentation.
- [Get assistant conversations](/api/analytics/assistant-conversations): Export AI assistant conversation history.
Expand All @@ -21,7 +23,7 @@
### Common use cases

- **Automated deployments**: Trigger site updates at set intervals or when events occur with [Trigger update](/api/update/trigger) and [Get update status](/api/update/status).
- **CI/CD integration**: Update documentation as part of your deployment pipeline when code changes with [Trigger update](/api/update/trigger).
- **CI/CD integration**: Update documentation as part of your <RainbowText>deployment</RainbowText> pipeline when code changes with [Trigger update](/api/update/trigger).
- **Custom integrations**: Embed the AI assistant into your product, support portal, or internal tools with [Generate assistant message](/api/assistant/create-assistant-message) and [Search documentation](/api/assistant/search).
- **Automated editing**: Use agent jobs to programmatically update documentation at scale with [Create agent job](/api/agent/create-agent-job), [Get agent job](/api/agent/get-agent-job), and [Get all agent jobs](/api/agent/get-all-jobs).
- **Analytics export**: Export feedback and assistant conversations for external analysis with [Get user feedback](/api/analytics/feedback) and [Get assistant conversations](/api/analytics/assistant-conversations).
Expand All @@ -34,11 +36,11 @@

### Admin API key

Use the admin API key to authenticate requests to [Trigger update](/api/update/trigger), [Get update status](/api/update/status), [Create agent job](/api/agent/create-agent-job), [Get agent job](/api/agent/get-agent-job), [Get all agent jobs](/api/agent/get-all-jobs), [Get user feedback](/api/analytics/feedback), and [Get assistant conversations](/api/analytics/assistant-conversations).

Check warning on line 39 in api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/introduction.mdx#L39

Use 'administrator' instead of 'admin'.

Admin API keys begin with the `mint_` prefix.

The admin API key is a server-side secret. Do not expose it in client-side code.

Check warning on line 43 in api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/introduction.mdx#L43

Use 'administrator' instead of 'admin'.

### Assistant API key

Expand Down
4 changes: 3 additions & 1 deletion api/update/status.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
openapi: "/openapi.json GET /project/update-status/{statusId}"
keywords: [ "update status", "deployment status", "check status" ]
keywords: [ "update status", "<RainbowText>deployment</RainbowText> status", "check status" ]
---

<Snippet file="snippets/components/rainbow-text.mdx" />
4 changes: 3 additions & 1 deletion api/update/trigger.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
openapi: "/openapi.json POST /project/update/{projectId}"
keywords: [ "trigger", "update", "deployment", "programmatic" ]
keywords: [ "trigger", "update", "<RainbowText>deployment</RainbowText>", "programmatic" ]
---

<Snippet file="snippets/components/rainbow-text.mdx" />
34 changes: 18 additions & 16 deletions changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@
noindex: true
---

<Snippet file="snippets/components/rainbow-text.mdx" />

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L12

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

Check warning on line 12 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L12

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

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.

Check warning on line 14 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L14

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

Check warning on line 14 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L14

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

Check warning on line 14 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L14

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

## Viewer role

Expand Down Expand Up @@ -50,7 +52,7 @@

- Editable icons
- What-you-see-is-what-you-get title and description editing for Cards, Accordions, and Steps components
- Hide and unhide pages from your navigation

Check warning on line 55 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L55

Did you really mean 'unhide'?
- Local image support in live preview
- Code block triggering with <code>```</code>
- More precise drag handle selection
Expand Down Expand Up @@ -87,7 +89,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 92 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L92

'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 @@ -97,7 +99,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 102 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L102

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

## Improvements

Expand All @@ -109,17 +111,17 @@

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L114

'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.

Check warning on line 115 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L115

Did you really mean 'quickstarts'?

## Web editor improvements

- **Live preview**: See real-time changes as you edit your documentation in the web editor. Live previews show your site exactly as it appears when published, without creating a preview deployment.
- **Live preview**: See real-time changes as you edit your documentation in the web editor. Live previews show your site exactly as it appears when published, without creating a preview <RainbowText>deployment</RainbowText>.
- **Unused files section**: The editor now shows unused pages that aren't in your navigation, with drag-and-drop support to add them.

## 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.
Added branch search functionality for GitHub and GitLab integrations so that it is easier to find and switch between <RainbowText>deployment</RainbowText> branches in the Git settings of your dashboard.

Check warning on line 124 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L124

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

## `mintlify validate` CLI command

Expand Down Expand Up @@ -182,7 +184,7 @@
You can now [customize your Slack bot](/ai/slack-bot) directly from the dashboard.

- **Choose a reply channel**: Select which channel the bot automatically replies to all messages in. The default is `#ask-ai`.
- **Customize the bot's appearance**: Change the bot's avatar and name from your dashboard.

Check warning on line 187 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L187

Did you really mean 'bot's'?

Check warning on line 187 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L187

Did you really mean 'bot's'?

## Mobile navigation improvements

Expand Down Expand Up @@ -217,7 +219,7 @@
- Updated [publishing workflow](/editor#publish-your-changes) 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 222 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L222

'Onboarding improvements' should use sentence-style capitalization.

Check warning on line 222 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L222

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 @@ -236,9 +238,9 @@
<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](/agent/suggestions) 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 241 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L241

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

## Q&A bots in Slack and Discord

Check warning on line 243 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L243

'Q&A bots in Slack and Discord' should use sentence-style capitalization.

Add bots powered by the assistant to your [Slack workspaces](/ai/slack-bot) and [Discord servers](/ai/discord). The bots answer questions in real-time based on your documentation, so they provide accurate, up-to-date answers to your communities.

Expand All @@ -251,8 +253,8 @@
## Improvements

- **Insights** renamed to **Analytics** in the dashboard.
- Added ability to delete a deployment from the dashboard.
- Added ability to delete a <RainbowText>deployment</RainbowText> 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 257 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L257

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 @@ -261,11 +263,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 266 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L266

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L270

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

</Update>
Expand All @@ -273,7 +275,7 @@
<Update label="December 9, 2025" tags={["New releases"]} rss={{ title: "Preview widget", description: "Track changed files in preview deployments with an interactive widget" }}>
## Preview widget

Preview deployments now include an interactive widget that displays all changed files in the deployment. The widget appears as a floating button in the bottom-right corner and provides:
Preview deployments now include an interactive widget that displays all changed files in the <RainbowText>deployment</RainbowText>. The widget appears as a floating button in the bottom-right corner and provides:

- One-click navigation to changed pages.
- Searchable list of all changed files with status badges (added, modified, removed).
Expand All @@ -287,7 +289,7 @@

You can now display "last modified" timestamps on all pages in your documentation. Enable this feature by setting the [`timestamp`](/organize/settings#param-timestamp) 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 292 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L292

Avoid using 'will'.

</Update>

Expand All @@ -303,16 +305,16 @@

## Assistant improvements

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

Check warning on line 308 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L308

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L309

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

## Bug fixes and reliability

- 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.

Check warning on line 316 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L316

Use 'turn off' or 'off' instead of 'disable'.
- 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 317 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L317

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

</Update>

Expand All @@ -325,10 +327,10 @@

</Update>

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

Check warning on line 330 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L330

'.mintignore support' should use sentence-style capitalization.
## .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 333 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L333

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 @@ -349,7 +351,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 354 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L354

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

Check warning on line 354 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L354

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 @@ -360,7 +362,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 365 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L365

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

Check warning on line 365 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L365

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

</Update>

Expand All @@ -368,7 +370,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 373 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L373

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 @@ -379,14 +381,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 384 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L384

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L391

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 @@ -401,7 +403,7 @@

## Component and styling enhancements

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

Check warning on line 406 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L406

In general, use active voice instead of passive voice ('be zoomed').
- Fixed keyboard shortcut styles inside callouts for dark mode
- Improved OG image generation with Google Fonts support and better truncation logic
- Improved UI for tables with better alignment, spacing, and readability
Expand All @@ -410,8 +412,8 @@

## Performance and infrastructure

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

Check warning on line 415 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L415

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

Check warning on line 416 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L416

Did you really mean 'prefetching'?

## Bug fixes and reliability

Expand All @@ -428,14 +430,14 @@
<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 433 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L433

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L434

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L439

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L440

Did you really mean 'nullable'?

Check warning on line 440 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L440

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.
- 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.
Expand All @@ -443,7 +445,7 @@
## 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 448 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L448

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

## Visual improvements

Expand All @@ -467,7 +469,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 472 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L472

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

## Assistant improvements
Expand All @@ -482,13 +484,13 @@
- Fixed props adjacent to `$refs` and `x-` props getting lost in OpenAPI parsing
- Fixed API playground modal header styling

## Web editor and deployment enhancements
## Web editor and <RainbowText>deployment</RainbowText> enhancements

- Restored manual create preview button for easier preview deployment creation
- Restored manual create preview button for easier preview <RainbowText>deployment</RainbowText> creation
- Added fetcher in dashboard for branch protections data
- Added fetcher in dashboard for PR status tracking
- Improved editor state management, enabling state to persist across browser sessions
- Fixed disabled state for editor publish button

Check warning on line 493 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L493

Use 'turn off' or 'off' instead of 'disabled'.
- Removed code block background in editor for cleaner appearance

## Performance and infrastructure
Expand Down Expand Up @@ -518,7 +520,7 @@

## Navigation and UI enhancements

- Added stable scrollbar gutter to navigation components for consistent layout

Check warning on line 523 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L523

Did you really mean 'scrollbar'?
- Made "On this page" section clickable to quickly scroll to the top of a page
- Fixed assistant bar positioning across all themes
- Improved assistant bar to prevent overlapping content
Expand Down Expand Up @@ -552,7 +554,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 557 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L557

Did you really mean 'list_pull_requests'?

Check warning on line 557 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L557

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 All @@ -567,7 +569,7 @@

- Removed background from code blocks in editor for cleaner appearance
- Fixed branch creation workflow to correctly navigate to newly created branches
- Added deployment history pagination
- Added <RainbowText>deployment</RainbowText> history pagination
- Added cursor pagination to preview deployments table
- Fixed preview deployments to only return preview environment deployments
- Improved dashboard UI/UX with better spacing, input handling, and layout fixes
Expand All @@ -584,19 +586,19 @@
## 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 589 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L589

Use 'URL' instead of 'url'.
- Added canonical tag for better SEO
- Fixed code block overscroll issues

Check warning on line 591 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L591

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L595

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

Check warning on line 596 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L596

Did you really mean 'read_external_files'?

## Component and styling

- Added dropdowns support in products division
- Fixed products and menu in middleware nav util function

Check warning on line 601 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L601

Did you really mean 'util'?
- Changed 404 page copy to be more clear
</Update>

Expand All @@ -607,13 +609,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 612 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L612

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L613

Did you really mean 'Shiki'?

Check warning on line 613 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L613

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L614

Did you really mean 'Twoslash'?

Check warning on line 614 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L614

Did you really mean 'Twoslash'?

## Accessibility improvements

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

Check warning on line 618 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L618

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 @@ -646,7 +648,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 651 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L651

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

## UI and user experience improvements

Expand All @@ -656,7 +658,7 @@

## Infrastructure and performance enhancements

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

Check warning on line 661 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L661

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

Check warning on line 661 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L661

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

## Bug fixes and reliability
Expand All @@ -675,14 +677,14 @@
## Authentication improvements

- Added support for validated redirect parameters in login callback to reduce login friction
- Improved login flow for SSO with better redirect handling

Check warning on line 680 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L680

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

## Bug fixes and reliability

- Fixed GitLab integration issues with larger repositories
- Improved dashboard loading performance with optimized deployment queries
- Improved dashboard loading performance with optimized <RainbowText>deployment</RainbowText> queries
- Fixed SVG path rendering issues in documentation
- Fixed keyboard navigation in search and chat functionality

Check warning on line 687 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L687

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

Check warning on line 702 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L702

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

## Web editor and deployments

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

Check warning on line 710 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L710

Avoid using 'will'.

Check warning on line 710 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L710

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

## API playground and navigation
Expand All @@ -716,9 +718,9 @@
## SEO and UI

- 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

Check warning on line 721 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L721

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

Check warning on line 723 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L723

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 @@ -747,34 +749,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 752 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L752

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L757

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L761

Did you really mean 'cdnjs'?

Check warning on line 761 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L761

Use 'CloudFront' instead of '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 768 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L768

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

## Web editor and deployment enhancements
## Web editor and <RainbowText>deployment</RainbowText> 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 773 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L773

Use 'capability' or 'feature' instead of 'functionality'.
- Optimized update workflow performance by cache-invalidating only changed pages during partial updates, reducing deployment times
- Optimized update workflow performance by cache-invalidating only changed pages during partial updates, reducing <RainbowText>deployment</RainbowText> 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 779 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L779

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 @@ -786,23 +788,23 @@

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L791

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" }}>
## Performance and build optimizations

- MDX transpilation now happens at deployment time instead of on every page load in uncached NextJS serverless environments, improving time to first byte for uncached pages.
- MDX transpilation now happens at <RainbowText>deployment</RainbowText> time instead of on every page load in uncached NextJS serverless environments, improving time to first byte for uncached pages.
- Content-based hashing prevents re-transpilation when MDX hasn't changed, reducing update workflow times by ~50% for customers with large page counts (deployments over 5 minutes should be roughly halved)
- Preview deployment viewing in the dashboard is now faster with added database indexes and query parallelization in our backend
- Preview <RainbowText>deployment</RainbowText> viewing in the dashboard is now faster with added database indexes and query parallelization in our backend

Check warning on line 799 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L799

Did you really mean 'parallelization'?
- Reduced page size by eliminating duplicate `navigation` data in each page's `rsc` payload—performance gains most noticeable with high page counts or complex navigation structures
- More aggressive prefetching enables instant page loads more frequently

Check warning on line 801 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L801

Did you really mean 'prefetching'?

## API playground and OpenAPI enhancements

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

Check warning on line 807 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L807

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

Check warning on line 816 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L816

Did you really mean 'prepending'?

## Analytics and LLM integrations

Expand All @@ -822,7 +824,7 @@

## Component and styling enhancements

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

Check warning on line 827 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L827

Did you really mean 'classnames'?
- Fixed `h{1-4}` tags rendering as `Heading` components with chips in custom page mode
- Added CSS selectors to [breadcrumbs](/organize/navigation#breadcrumbs) for custom CSS targeting
- Fixed stretched open-graph images by analyzing dimensions to maintain proportions at 56px height
Expand All @@ -833,9 +835,9 @@

- Fixed PDF render issues with certain page titles by sanitizing characters that cause generation problems
- Resolved CLI error `Cannot convert undefined or null to object` when encountering empty OpenAPI JSON files
- Fixed custom `docs.json` open-graph metatags being overwritten by generated ones

Check warning on line 838 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L838

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

Check warning on line 839 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L839

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

Check warning on line 839 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L839

Use 'path' instead of 'pathname'.

Check warning on line 839 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L839

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

Check warning on line 840 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L840

Did you really mean 'sourcemaps'?

## Technical improvements

Expand All @@ -849,9 +851,9 @@

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L854

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

Check warning on line 856 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L856

Did you really mean 'misconfiguration'?

## API playground enhancements

Expand All @@ -867,20 +869,20 @@

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L872

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L873

Use 'email' instead of 'Email'.

Check warning on line 873 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L873

Did you really mean 'autofocuses'?
- Both custom domains and subdomains in Redis for a performance improvement on navigation load times (~50ms latency reduction)

Check warning on line 874 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L874

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

## Technical improvements

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

Check warning on line 881 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L881

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L884

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L885

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 @@ -895,7 +897,7 @@

## API playground enhancements

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

Check warning on line 900 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L900

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 @@ -908,15 +910,15 @@

## Performance and reliability

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

Check warning on line 913 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L913

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L915

Use 'Gantt' instead of 'GANTT'.

Check warning on line 915 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L915

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

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

Check warning on line 920 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L920

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

Check warning on line 921 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L921

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

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

Check warning on line 929 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L929

Did you really mean 'DMs'?
- One-click setup: Install directly from your Mintlify dashboard in seconds
- Contextual answers: Searches your entire documentation to provide relevant, accurate responses
- Deflect support interruptions: Turn daily questions into instant, self-serve answers
Expand All @@ -946,17 +948,17 @@
<Update label="June 2025" tags={["New releases", "Improvements"]} rss={{ title: "June Product Updates", description: "AI assistant updates and subscribable changelogs" }}>
## AI assistant updates

- Improved accuracy through agentic RAG with tool calling

Check warning on line 951 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L951

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

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

## Subscribable changelogs

Check warning on line 958 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L958

Use 'subscribable' instead of 'Subscribable'.

- Automatically generate an RSS feed from changelog pages

Check warning on line 960 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L960

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

Check warning on line 961 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L961

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

Learn more in our new [Changelog guide](/create/changelogs)
</Update>
Expand All @@ -977,10 +979,10 @@
</Update>

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

Check warning on line 982 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L982

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

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

Check warning on line 985 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L985

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

Expand All @@ -996,14 +998,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 1001 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1001

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

## AI Translations in beta

Check warning on line 1008 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1008

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

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

- Tag changelog updates so end users can filter updates
- Sonnet-3.7 supported for AI Chat. Configure your preferred model through the dashboard
- Change your deployment name directly in dashboard settings
- Change your <RainbowText>deployment</RainbowText> name directly in dashboard settings

## Bug fixes

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1042

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1045

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

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

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

## CI Checks

Check warning on line 1072 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1072

'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

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1078

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

## More Themes

Check warning on line 1080 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1080

'More Themes' should use sentence-style capitalization.

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

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1097

Avoid using 'will'.
</Update>

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

Check warning on line 1101 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1101

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

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

## Partial Authentication

Check warning on line 1108 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1108

'Partial Authentication' should use sentence-style capitalization.

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

## Revamped API Playground

Check warning on line 1112 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1112

'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 @@ -1130,18 +1132,18 @@
</Update>

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

Check warning on line 1135 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1135

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1142

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1146

'Web Editor' should use sentence-style capitalization.

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

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

## /llms.txt support

Check warning on line 1155 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1155

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

Check warning on line 1155 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1155

Use 'LLMs' instead of 'llms'.

<Frame>
![llms.txt support](/images/changelog/llms.jpg)

Check warning on line 1158 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1158

Use 'LLMs' instead of 'llms'.
</Frame>
All docs instances are now automatically hosted at /llms.txt and /llms-full.txt so that LLMs can easily ingest your documentation. For more information, read the [docs on the new llms.txt standard.](https://llmstxt.org)

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1164

Avoid using 'will'.

### Quality Improvements

Expand All @@ -1175,14 +1177,14 @@
<Frame>
![Changelog](/images/changelog/changelog.jpg)
</Frame>
## Code Line Highlighting

Check warning on line 1180 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1180

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1185

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

Check warning on line 1187 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L1187

Use semicolons judiciously.
}
sayHello();
```
Expand Down Expand Up @@ -1228,7 +1230,7 @@
- Consolidated the login and signup pages to decrease friction and confusion.
- Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them.
- Added login with Google OAuth
- Added ability to add new deployment through dashboard settings.
- Added ability to add new <RainbowText>deployment</RainbowText> through dashboard settings.

## Bug Fixes

Expand Down Expand Up @@ -1397,4 +1399,4 @@
- Snippets V2: We now support fully reusable components and variables for snippets.
- Open-source MDX Engine: We've exposed two APIs—getCompiledMdx and MDXComponent—so you can access Mintlify markdown and code syntax highlighting. [Contributions to the project](https://github.com/mintlify/mdx) are welcome.
- AI Chat Insights: Segment chat history by date and increase AI Chat quota from the dashboard, and see how often a specific query appears.
</Update>
</Update>
4 changes: 3 additions & 1 deletion customize/custom-domain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@
keywords: ["custom domain setup", "DNS configuration", "CNAME records", "TLS certificates"]
---

<Snippet file="snippets/components/rainbow-text.mdx" />

To host your documentation on a custom domain:
1. Add your domain in your dashboard.
2. Configure DNS settings on your domain provider.
3. Allow time for DNS to propagate and TLS certificates to be automatically provisioned.

Check warning on line 13 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L13

Use 'tls' instead of 'TLS'.

Check warning on line 13 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L13

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

<Info>
Looking to set up a subpath like `example.com/docs`? See [/docs subpath](/deploy/docs-subpath).
Expand All @@ -16,7 +18,7 @@

## Add your custom domain

1. Navigate to the [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard.
1. Navigate to the [Custom domain setup](https://dashboard.mintlify.com/settings/<RainbowText>deployment</RainbowText>/custom-domain) page in your dashboard.
2. Enter your domain name. For example, `docs.example.com` or `www.example.com`.
3. Click **Add domain**.

Expand Down Expand Up @@ -48,19 +50,19 @@

### DNS propagation

DNS changes typically take 1-24 hours to propagate globally, though it can take up to 48 hours in some cases. You can verify your DNS is configured correctly using [DNSChecker](https://dnschecker.org).

Check warning on line 53 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L53

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

Once your DNS records are active, your documentation is first accessible via HTTP. HTTPS is available after Vercel provisions your TLS certificate.

Check warning on line 55 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L55

Use 'tls' instead of 'TLS'.

Check warning on line 55 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L55

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

### Automatic TLS provisioning

Check warning on line 57 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L57

'Automatic TLS provisioning' should use sentence-style capitalization.

Check warning on line 57 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L57

Use 'tls' instead of 'TLS'.

Check warning on line 57 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L57

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

Once your DNS records propagate and resolve correctly, Vercel automatically provisions a free SSL/TLS certificate for your domain using Let's Encrypt.

Check warning on line 59 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L59

Use 'tls' instead of 'TLS'.

Check warning on line 59 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L59

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

This typically completes within a few hours of DNS propagation, though it can take up to 24 hours in rare cases. Certificates are automatically renewed before expiration.

### CAA records

Check warning on line 63 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L63

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

Check warning on line 63 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L63

'CAA records' should use sentence-style capitalization.

If your domain uses CAA (Certification Authority Authorization) records, you must authorize Let's Encrypt to issue certificates for your domain. Add the following CAA record to your DNS settings:

Check warning on line 65 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L65

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

Check warning on line 65 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L65

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

```text
0 issue "letsencrypt.org"
Expand All @@ -68,21 +70,21 @@

### Reserved paths

The `/.well-known/acme-challenge` path is reserved for certificate validation and cannot be redirected or rewritten. If you have configured redirects or rewrites for this path, certificate provisioning will fail.

Check warning on line 73 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L73

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

Check warning on line 73 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L73

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

Check warning on line 73 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L73

Avoid using 'will'.

### Provider-specific settings

<AccordionGroup>
<Accordion title="Vercel verification">
If Vercel is your domain provider, you must add a verification `TXT` record. This information appears on your dashboard after submitting your custom domain, and is emailed to you.

Check warning on line 79 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L79

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

<Accordion title="Cloudflare encryption mode">
If Cloudflare is your DNS provider, you must enable the "Full (strict)" mode for the SSL/TLS encryption setting. Additionally, disable "Always Use HTTPS" in your Edge Certificates settings. Cloudflare's HTTPS redirect will block Let's Encrypt from validating your domain during certificate provisioning.

Check warning on line 83 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L83

Use 'tls' instead of 'TLS'.

Check warning on line 83 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L83

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

Check warning on line 83 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L83

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

Check warning on line 83 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L83

Avoid using 'will'.
</Accordion>
</AccordionGroup>

## Set a canonical URL

Check warning on line 87 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L87

'Set a canonical URL' should use sentence-style capitalization.

After configuring your DNS, set a canonical URL to ensure search engines index your preferred domain. A canonical URL tells search engines which version of your documentation is the primary one. This improves SEO when your documentation is accessible from multiple URLs and prevents issues with duplicate content.

Expand Down
4 changes: 3 additions & 1 deletion dashboard/audit-logs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
keywords: ["monitoring", "activity tracking", "security", "compliance"]
---

<Snippet file="snippets/components/rainbow-text.mdx" />

<Info>
Audit logs are available on [Enterprise plans](https://mintlify.com/pricing?ref=audit-logs).
</Info>
Expand All @@ -24,7 +26,7 @@
| Field | Description |
| ----- | ----------- |
| Timestamp | Date and time when the action occurred |
| Actor | Email address of the user who performed the action |

Check warning on line 29 in dashboard/audit-logs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/audit-logs.mdx#L29

Use 'email' instead of 'Email'.
| Action | What action the user performed |
| Category | Type of resource affected |
| Outcome | Whether the action succeeded or failed |
Expand All @@ -43,7 +45,7 @@
| Organization | Organization settings updates and deletion requests. |
| Member | Team member invitations, removals, and role changes. |
| Deployment | Deployment configuration changes including custom domains, authentication, and Git sources. |
| Preview deployment | Preview deployment creation, updates, and authentication changes. |
| Preview <RainbowText>deployment</RainbowText> | Preview <RainbowText>deployment</RainbowText> creation, updates, and authentication changes. |
Copy link

Choose a reason for hiding this comment

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

RainbowText in markdown table breaks table rendering

Medium Severity

<RainbowText>deployment</RainbowText> is placed in a markdown table cell that serves as a category label (| Preview <RainbowText>deployment</RainbowText> |). Markdown table cells may not reliably render JSX components, and the content mismatch between the "Deployment" row (unchanged) and the "Preview deployment" row (rainbow-styled) creates inconsistency. The column alignment could also be disrupted by the JSX tag length.

Fix in Cursor Fix in Web

| API key | API key and discovery API key creation and deletion. |
| Assistant | Assistant setting updates like deflection email, web search sites, and starter questions. |
| PDF export | PDF export generation and deletion. |
Expand Down
8 changes: 5 additions & 3 deletions dashboard/permissions.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: "Deployment permissions"
description: "Understand deployment differences between people in your organization and other contributors."
keywords: ["editor access", "permissions", "team", "seats", "deployment"]
description: "Understand <RainbowText>deployment</RainbowText> differences between people in your organization and other contributors."
keywords: ["editor access", "permissions", "team", "seats", "<RainbowText>deployment</RainbowText>"]
---

<Snippet file="snippets/components/rainbow-text.mdx" />

People with the editor or admin [role](/dashboard/roles) can use the web editor, trigger deployments, and manage integrations from your dashboard. When an editor or admin publishes through the web editor or merges a pull request into your documentation repository, the changes deploy to your live site automatically.

Check warning on line 9 in dashboard/permissions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/permissions.mdx#L9

Use 'administrator' instead of 'admin'.

Check warning on line 9 in dashboard/permissions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/permissions.mdx#L9

Use 'administrator' instead of 'admin'.

Anyone with access to your documentation repository can contribute to your documentation by pushing changes to the repository, but their changes do not deploy until an editor or admin manually triggers a deployment from your dashboard.
Anyone with access to your documentation repository can contribute to your documentation by pushing changes to the repository, but their changes do not deploy until an editor or admin manually triggers a <RainbowText>deployment</RainbowText> from your dashboard.

Check warning on line 11 in dashboard/permissions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/permissions.mdx#L11

Use 'administrator' instead of 'admin'.
8 changes: 5 additions & 3 deletions deploy/ci.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,30 @@
keywords: ["continuous integration", "CI/CD", "checks", "Vale", "linter"]
---

<Snippet file="snippets/components/rainbow-text.mdx" />

<Info>
[Pro and Enterprise plans](https://mintlify.com/pricing?ref=docs-ci) include CI checks for GitHub repositories.
</Info>

Use CI checks to lint your docs for errors and provide warnings before you deploy. Mintlify CI checks run on pull requests against a configured deployment branch.
Use CI checks to lint your docs for errors and provide warnings before you deploy. Mintlify CI checks run on pull requests against a configured <RainbowText>deployment</RainbowText> branch.

## Installation

To begin, follow the steps on the [GitHub](/deploy/github) page.

<Tip>
Only access to the repository where your documentation content exists is required, so it is highly recommended to only grant access to that repository.

Check warning on line 20 in deploy/ci.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ci.mdx#L20

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

## Configuration

Configure the CI checks enabled for a deployment by navigating to the [Add-ons](https://dashboard.mintlify.com/products/addons) page of your dashboard. Enable the checks that you want to run.
Configure the CI checks enabled for a <RainbowText>deployment</RainbowText> by navigating to the [Add-ons](https://dashboard.mintlify.com/products/addons) page of your dashboard. Enable the checks that you want to run.

When enabling checks, you can choose to run them at a `Warning` or `Blocking` level.

- A `Warning` level check will never provide a failure status, even if there is an error or suggestions.

Check warning on line 29 in deploy/ci.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ci.mdx#L29

Avoid using 'will'.
- A `Blocking` level check will provide a failure status if there is an error or suggestions.

Check warning on line 30 in deploy/ci.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ci.mdx#L30

Avoid using 'will'.

## Available CI checks

Expand All @@ -43,7 +45,7 @@
Mintlify supports automatically running Vale in a CI check and displaying the results as a check status.

#### Configuration
If you have a `.vale.ini` file in the root content directory of your deployment, the Vale CI check uses that configuration file and any configuration files in your specified `stylesPath`.
If you have a `.vale.ini` file in the root content directory of your <RainbowText>deployment</RainbowText>, the Vale CI check uses that configuration file and any configuration files in your specified `stylesPath`.

If you don't have a Vale config file, the default configuration automatically loads.

Expand Down Expand Up @@ -355,8 +357,8 @@

To add your own vocabulary for the default configuration, create a `styles/config/vocabularies/Mintlify` directory with `accept.txt` and `reject.txt` files.

- `accept.txt`: Words that should be ignored by the Vale linter. For example, product names or uncommon terms.

Check warning on line 360 in deploy/ci.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ci.mdx#L360

In general, use active voice instead of passive voice ('be ignored').
- `reject.txt`: Words that should be flagged as errors. For example, jargon or words that are not appropriate for the tone of your documentation.

Check warning on line 361 in deploy/ci.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ci.mdx#L361

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

```text Example Vale file structure
/your-project
Expand Down Expand Up @@ -394,7 +396,7 @@
</Note>

#### Packages
Vale supports a range of [packages](https://vale.sh/docs/keys/packages), which can be used to check for spelling and style errors. Any packages you include in your repository under the correct `stylesPath` are automatically installed and used in your Vale configuration.

Check warning on line 399 in deploy/ci.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ci.mdx#L399

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

For packages not included in your repository, you may specify any packages from the [Vale package registry](https://vale.sh/explorer), and they're automatically downloaded and used in your Vale configuration.

Expand All @@ -413,9 +415,9 @@
```mdx
{/* vale off */}

This text is ignored by Vale

Check warning on line 418 in deploy/ci.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ci.mdx#L418

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

{/* vale on */}
```

Vale automatically recognizes and respects these comments in MDX files without additional configuration. Use comments to skip lines or sections that should be ignored by the linter.

Check warning on line 423 in deploy/ci.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ci.mdx#L423

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