Skip to content
Closed
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
142 changes: 142 additions & 0 deletions changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,154 @@
noindex: true
---

<Update label="November 21" tags={["New releases", "Improvements"]} rss={{ title: "Weekly Updates", description: "Standard Markdown support, custom syntax highlighting, API playground enhancements, and web editor improvements" }}>
## New features

- **Standard Markdown file support**: You can now use standard `.md` files in addition to `.mdx` files in your documentation, making it easier to migrate existing Markdown content without conversion
- **Custom syntax highlighting**: Add support for custom programming languages in code blocks through the `styling.codeblocks.customLanguages` field in `docs.json`, enabling syntax highlighting for domain-specific languages with custom Shiki grammars

Check warning on line 12 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L12

Did you really mean 'Shiki'?
- **PowerShell and Swift code examples**: API playground now generates code examples in PowerShell and Swift, expanding language support for API testing and integration
- **View component**: New `<View>` component for conditional rendering based on screen size or other display properties

## API playground improvements

- Fixed issue where switching between response examples with different indices would fail to render the response section
- Resolved double Authorization header bug that was causing authentication issues in API requests
- Fixed oneOf schema rendering issues that were causing incorrect field displays in complex API schemas

Check warning on line 20 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L20

Did you really mean 'oneOf'?
- Improved response example generation to properly merge and display all required properties
- Fixed missing path parameters on certain API documentation pages
- Fixed extra separator appearing in array item schemas with no contents
- Fixed missing prefill examples in object arrays
- Improved handling of primitive parameters to ensure they're properly displayed
- Fixed description padding and layout issues in API playground modals
- Enhanced request body type and response body type synchronization with code examples
- Fixed missing query parameter descriptions in API documentation
- Improved performance of API playground inputs to reduce lag during typing
- Object fields now properly respect the `expanded` setting from `docs.json` configuration
- Fixed prefilling from `schema.example` to properly populate example values
- Fixed request example generation for top-level oneOf types

Check warning on line 32 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L32

Did you really mean 'oneOf'?
- Fixed type labels to display more accurate information about field types
- Fixed Coinbase playground issues for specific endpoints

Check warning on line 34 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L34

Did you really mean 'Coinbase'?
- Improved handling of circular schema references to properly render descriptions
- Fixed various API page rendering issues including missing fields and incorrect layouts

## Web editor enhancements

- Branch switching is now fully integrated into the editor UI with improved navigation and state management
- Fixed race condition when committing changes that could cause branch SHA mismatches

Check warning on line 41 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L41

Spell out 'SHA', if it's unfamiliar to the audience.
- Removed implicit folder directory logic for cleaner file organization
- Fixed file creation and renaming to properly match original file locations in MDX frontmatter
- Improved folder state persistence across editor sessions
- Fixed branch navigation where changing URL to specific branch would redirect incorrectly
- Added merge conflict resolution tracking and improved conflict dialog functionality

Check warning on line 46 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L46

Use 'capability' or 'feature' instead of 'functionality'.
- Fixed file state updates after committing changes
- Spaces in file rename inputs are now automatically replaced with dashes for consistency
- Added video support in the editor for embedding video content
- Fixed handling of moving files to previously deleted paths

## Component and styling enhancements

- **Badge component**: New `<Badge>` component for displaying status indicators, labels, and tags with customizable colors
- Images can now be zoomed with improved overlay styling for both light and dark modes

Check warning on line 55 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L55

In general, use active voice instead of passive voice ('be zoomed').
- Fixed image icon backgrounds for dark mode to prevent display issues
- Fixed CardGroup prose styles to ensure proper text formatting within cards
- Fixed italic font rendering issues across the documentation
- Updated gray colors to new design system values for better consistency
- Fixed callouts nested items colors for improved readability
- Fixed font rendering for single code items to use proper monospace fonts

Check warning on line 61 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L61

Did you really mean 'monospace'?
- Improved inline code selection to select only code content on triple-click

## Navigation and UI improvements

Check warning on line 64 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L64

'Navigation and UI improvements' should use sentence-style capitalization.

- Tab hover indicators now have improved styling with consistent tab titles
- Fixed top-level tabs rendering and navigation
- Fixed page top padding for better visual consistency
- Long words now wrap properly with `overflow-wrap` to prevent horizontal scrolling
- Step component now handles cases where no step title is provided

Check warning on line 70 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L70

In general, use active voice instead of passive voice ('is provided').
- Fixed heading IDs to properly handle question marks and special characters for anchor links
- Icon component now accepts `className` prop for custom styling
- Fixed theme toggle colors for better visibility in both light and dark modes
- External links now properly open in new tabs
- Fixed badge position inside navigation group dropdowns
- Improved alignment for table headers and cells with tabular numbers
- Fixed scroll behavior for tables inside tabs and steps inside tabs

## Performance and infrastructure

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

Check warning on line 81 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L81

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

Check warning on line 82 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L82

Did you really mean 'prefetching'?
- KaTeX CSS is now conditionally loaded only when needed, reducing unnecessary asset loading
- Added YAML support to Shiki language constants for better syntax highlighting coverage

Check warning on line 84 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L84

Did you really mean 'Shiki'?
- Improved custom font loading user experience with better error handling

## Bug fixes and reliability

- Fixed 500 errors in dashboard caused by Shiki syntax highlighting issues

Check warning on line 89 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L89

Did you really mean 'Shiki'?
- Fixed empty expandable objects in API documentation
- Removed example data for additional properties to prevent confusion
- Fixed propagation of required fields in oneOf schemas

Check warning on line 92 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L92

Did you really mean 'oneOf'?
- Fixed duplicated descriptions in API documentation
- Fixed missing parent names with dots in schema paths
- Fixed description rendering above tabs for objects with oneOf description combinations

Check warning on line 95 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L95

Use 'preceding' instead of 'above'.

Check warning on line 95 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L95

Did you really mean 'oneOf'?
- Improved handling of allOf schemas to properly concatenate descriptions

Check warning on line 96 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L96

Did you really mean 'allOf'?
- Fixed missing defaults with allOf schemas

Check warning on line 97 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L97

Did you really mean 'allOf'?
- Fixed unique key assignment to properly account for array indices in API fields
- Improved error messages for invalid URLs in API configurations
- Fixed playground error display to prevent height shrinking
- Fixed redirect behavior for OAuth to properly include base paths
- Removed dual base path issues in authentication login links
- Fixed sidebar display on non-API pages
- Fixed OG image generation with better truncation logic and Google Fonts support
- Fixed table of contents rendering issues
- Fixed favicon isolation to prevent conflicts between different documentation sites
- Fixed keyboard shortcut styles inside callouts for dark mode
- Fixed Palm theme sidebar styling issues
- Fixed zoomed image overlay background color for light theme
- Fixed scroll height capping for very long API responses
- Fixed button variants for consistent styling across the dashboard

## CLI improvements

Check warning on line 113 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L113

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

- Added error logging for lower Node.js versions to help users identify compatibility issues
- Fixed max file size validation in CLI (increased from 5MB to 20MB)

Check warning on line 116 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L116

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

Check warning on line 116 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L116

Use parentheses judiciously.

Check warning on line 116 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L116

Put a nonbreaking space between the number and the unit in '5MB'.

Check warning on line 116 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L116

Put a nonbreaking space between the number and the unit in '20MB'.
- Custom syntax highlighting now works properly in CLI local development

Check warning on line 117 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L117

Use 'command-line tool' instead of 'CLI'.
- Added early failure if Node 25 is being used with `mint dev` command

Check warning on line 118 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L118

In general, use active voice instead of passive voice ('being used').
- Fixed CLI bugs on Windows and added tests to prevent regressions

Check warning on line 119 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L119

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

## Security enhancements

- Improved redirect validation to prevent XSS and open redirect vulnerabilities
- Enhanced path traversal defense mechanisms
- Disallowed direct access to internal markdown, RSS, and MCP routes via `_mintlify` path

Check warning on line 125 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L125

Spell out 'RSS', if it's unfamiliar to the audience.
- Improved authentication security with better validation and error handling
- Added validation for organization ownership before setting GitHub sources

## Dashboard improvements

- Fixed dashboard design inconsistencies and improved spacing throughout
- Improved button sizing and layout for organization invitations
- Fixed disabled state for editor publish button

Check warning on line 133 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L133

Use 'turn off' or 'off' instead of 'disabled'.
- Added better handling for links in dashboard assistant chat
- Fixed outline issues for chat assistant in Firefox
- Improved deployment history with pagination support
- Added cursor pagination to preview deployments table
- Fixed preview deployments to only return preview environment deployments
- Improved email validation with explicit error messages
- Fixed whitespace handling in email address validation

## Localization

- Added support for additional languages in authentication flows
- Updated translations for contextual menu and assistant features
- Improved language selector functionality across all themes

Check warning on line 146 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L146

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

</Update>

<Update label="November 15" tags={["New releases", "Improvements"]} rss={{ title: "Weekly Updates", description: "Badge component, API playground improvements, custom language support, and performance enhancements" }}>
## 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 154 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L154

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

Check warning on line 155 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L155

Did you really mean 'heatmap'?

## API playground improvements

Expand All @@ -20,14 +162,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 165 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L165

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

Check warning on line 168 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L168

'Navigation and UI enhancements' should use sentence-style capitalization.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L172

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 @@ -42,7 +184,7 @@

## Component and styling enhancements

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

Check warning on line 187 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L187

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 @@ -51,8 +193,8 @@

## Performance and infrastructure

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

Check warning on line 196 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L196

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

Check warning on line 197 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L197

Did you really mean 'prefetching'?

## Bug fixes and reliability

Expand All @@ -69,14 +211,14 @@
<Update label="October 31" 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 214 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L214

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L215

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L220

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L221

Did you really mean 'nullable'?

Check warning on line 221 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L221

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 @@ -84,7 +226,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 229 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L229

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

## Visual improvements

Expand All @@ -96,7 +238,7 @@
- Improved LaTeX/math block styling for better readability and consistent formatting.
- Added `playsInline` and autoplay props to video embeds so they work correctly on iOS devices.
- Updated Claude icon with proper border-radius for visual consistency.
- Fixed `/llms.txt` routing so LLM agents can properly access documentation.

Check warning on line 241 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L241

Spell out 'LLM', if it's unfamiliar to the audience.
- Prevented infinite schema expansion in complex OpenAPI specs that could cause browser crashes.
- Removed x-overflow in Palm theme that was cutting off text in the API playground.
- Increased content font-size to improve compatibility with browser reader modes.
Expand All @@ -108,7 +250,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 253 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L253

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

## Assistant improvements
Expand All @@ -129,7 +271,7 @@
- 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 274 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L274

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

## Performance and infrastructure
Expand Down Expand Up @@ -157,9 +299,9 @@
- Enhanced assistant search with parallel documentation queries for faster results
- Fixed assistant disappearing bug and improved visibility on small pages

## Navigation and UI enhancements

Check warning on line 302 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L302

'Navigation and UI enhancements' should use sentence-style capitalization.

- Added stable scrollbar gutter to navigation components for consistent layout

Check warning on line 304 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L304

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 All @@ -177,10 +319,10 @@
## Bug fixes and reliability

- Fixed locale switching to stay on the same page instead of redirecting to the home page
- Fixed broken links CLI to exit with code 1 for CI/CD integration

Check warning on line 322 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L322

Use 'command-line tool' instead of 'CLI'.
- Fixed local font paths to properly prepend forward slash
- Fixed redirect handling to ignore leading slashes in `docs.json`
- Fixed canonical URL stripping of `/index` for better SEO

Check warning on line 325 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L325

Spell out 'SEO', if it's unfamiliar to the audience.
- Fixed ordered list positioning inside accordions
- Fixed `<span>` tag styling to behave like `<p>` tags
- Fixed display block for first `<p>` tag in lists
Expand All @@ -193,7 +335,7 @@
<Update label="October 11" 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 338 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L338

Did you really mean 'list_pull_requests'?

Check warning on line 338 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L338

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

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

Check warning on line 371 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L371

Spell out 'SEO', if it's unfamiliar to the audience.
- Fixed code block overscroll issues

Check warning on line 372 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L372

Did you really mean 'overscroll'?
- Made search engines ignore preview deployments for SEO purposes

Check warning on line 373 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L373

Spell out 'SEO', if it's unfamiliar to the audience.
- Fixed referrer tracking to use domain instead of full URL
- Fixed images always becoming MDX block elements (kept inline images inline)

Check warning on line 375 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L375

Use parentheses judiciously.
- Removed comments in raw markdown pages such that you can use TODO comments without them leaking to users
- Fixed directory reading support for read_external_files

Check warning on line 377 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L377

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L382

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

<Update label="October 3" tags={["New releases", "Improvements"]} rss={{ title: "Weekly Updates", description: "Products navigation, accessibility CLI, API playground enhancements, and extensive accessibility improvements" }}>

Check warning on line 386 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L386

Use 'command-line tool' instead of 'CLI'.
## New features

- **Products navigation**: Organize documentation for multiple products with the product switcher navigation
- **Accessibility CLI command**: Run `mint a11y` to test your docs for accessibility issues

Check warning on line 390 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L390

Use 'command-line tool' instead of 'CLI'.
- **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 393 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L393

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L394

Did you really mean 'Shiki'?

Check warning on line 394 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L394

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L395

Did you really mean 'Twoslash'?

Check warning on line 395 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L395

Did you really mean 'Twoslash'?

## Accessibility improvements

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

Check warning on line 399 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L399

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 All @@ -272,13 +414,13 @@
- Fixed z-index issues with side panel overlays
- Fixed light mode color fallbacks and theme-related styling bugs
- Fixed API playground expandables not working with anchor links
- Fixed `.md` link accessibility for ChatGPT and other LLM agents

Check warning on line 417 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L417

Spell out 'LLM', if it's unfamiliar to the audience.
- Fixed image dimension handling for percentage-based widths and heights
- Fixed code block rendering issues with language tags and custom themes
- Fixed accordion link formatting and styling
- Fixed footer spacing when assistant configuration is empty
- Fixed card icon rendering for local repository images
- Fixed audio file handling in API playground (prevented UTF-8 decoding)

Check warning on line 423 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L423

Use parentheses judiciously.
- Improved PR publish state management in web editor
</Update>

Expand All @@ -287,9 +429,9 @@

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

Check warning on line 432 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L432

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

## UI and user experience improvements

Check warning on line 434 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L434

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

- Fixed tab visibility issues on 404 pages to prevent incorrect active tab highlighting
- Enhanced image handling with proper width and height attribute passing for non-optimized images
Expand All @@ -297,7 +439,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 442 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L442

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

Check warning on line 442 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L442

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

## Bug fixes and reliability
Expand All @@ -316,14 +458,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 461 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L461

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
- Fixed SVG path rendering issues in documentation
- Fixed keyboard navigation in search and chat functionality

Check warning on line 468 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L468

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

<Update label="September 13" 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 @@ -331,14 +473,14 @@

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

Check warning on line 476 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L476

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

## Assistant and MCP

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

Check warning on line 483 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L483

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

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

Check warning on line 491 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L491

Avoid using 'will'.

Check warning on line 491 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L491

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

Check warning on line 492 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L492

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

## API playground and navigation

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

## SEO and UI

Check warning on line 499 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L499

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

Check warning on line 499 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L499

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

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

Check warning on line 501 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L501

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

Check warning on line 502 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L502

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L504

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

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

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

Check warning on line 517 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L517

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

## Navigation and quality of life improvements

Expand All @@ -388,34 +530,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 533 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L533

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

Check warning on line 533 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L533

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

Check warning on line 533 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L533

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

## Component and styling enhancements

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

Check warning on line 538 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L538

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L542

Did you really mean 'cdnjs'?

Check warning on line 542 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L542

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

Check warning on line 542 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L542

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

<Update label="August 23" 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 549 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L549

Use parentheses judiciously.

Check warning on line 549 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L549

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

## Web editor and deployment enhancements

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

Check warning on line 554 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L554

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

## Authentication and navigation improvements

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

Check warning on line 560 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L560

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 @@ -427,23 +569,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 572 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L572

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

Check warning on line 572 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L572

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

<Update label="August 16" 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.
- Content-based hashing prevents re-transpilation when MDX hasn't changed, reducing update workflow times by ~50% for customers with large page counts (deployments over 5 minutes should be roughly halved)

Check warning on line 579 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L579

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

Check warning on line 580 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L580

Did you really mean 'parallelization'?

Check warning on line 580 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L580

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

Check warning on line 582 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L582

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L588

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

Expand All @@ -452,18 +594,18 @@
- 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 597 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L597

Did you really mean 'prepending'?

## Analytics and LLM integrations

Check warning on line 599 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L599

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

Check warning on line 599 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L599

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

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

Check warning on line 601 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L601

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

Check warning on line 603 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L603

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

## Component and styling enhancements

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

Check warning on line 608 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L608

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 @@ -473,10 +615,10 @@
## Bug fixes and reliability

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

Check warning on line 618 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L618

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

Check warning on line 619 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L619

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L620

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

Check warning on line 620 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L620

Use 'path' instead of 'pathname'.

Check warning on line 620 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L620

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

Check warning on line 621 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L621

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

Check warning on line 621 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L621

Did you really mean 'sourcemaps'?

## Technical improvements

Expand All @@ -490,9 +632,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 635 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L635

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

Check warning on line 636 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L636

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

Check warning on line 637 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L637

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

Check warning on line 637 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L637

Did you really mean 'misconfiguration'?

## API playground enhancements

Expand All @@ -503,27 +645,27 @@

## Assistant updates

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

Check warning on line 648 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L648

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

## Performance and reliability

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

Check warning on line 653 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L653

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L654

Use 'email' instead of 'Email'.

Check warning on line 654 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L654

Did you really mean 'autofocuses'?

Check warning on line 654 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L654

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

Check warning on line 655 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L655

Use parentheses judiciously.

Check warning on line 655 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L655

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L662

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

Check warning on line 662 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L662

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

Check warning on line 663 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L663

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

Check warning on line 665 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L665

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

Check warning on line 665 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L665

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L666

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

Check warning on line 668 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L668

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

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

Check warning on line 677 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L677

Use parentheses judiciously.

## API playground enhancements

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

Check warning on line 681 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L681

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 @@ -549,15 +691,15 @@

## Performance and reliability

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

Check warning on line 694 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L694

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

Check warning on line 695 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L695

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

Check warning on line 696 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L696

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

Check warning on line 697 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L697

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

## Technical improvements

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

Check warning on line 701 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L701

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

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

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

Check warning on line 710 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L710

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

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

Check warning on line 715 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L715

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

## Hosted MCP servers

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

Check warning on line 719 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L719

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

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

Expand All @@ -587,7 +729,7 @@
<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 732 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L732

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
Expand All @@ -596,10 +738,10 @@

## Subscribable changelogs

- Automatically generate an RSS feed from changelog pages

Check warning on line 741 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L741

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

Check warning on line 742 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L742

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

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

Check warning on line 744 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L744

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

<Update label="May 2025" tags={["Improvements"]}>
Expand All @@ -618,10 +760,10 @@
</Update>

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

Check warning on line 763 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L763

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

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

Check warning on line 766 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L766

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

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

Check warning on line 775 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L775

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

**Additional fixes**

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

Check warning on line 782 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L782

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L789

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

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

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

Check warning on line 823 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L823

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L826

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

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

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

1. Make sure your CLI is the latest version

Check warning on line 839 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L839

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

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

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

## CI Checks

Check warning on line 853 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L853

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

Check warning on line 855 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L855

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

## .md support for LLMs

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

Check warning on line 859 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L859

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

## More Themes

Check warning on line 861 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L861

'More Themes' should use sentence-style capitalization.

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

- [Guide to Technical Writing:](https://mintlify.com/guides/introduction)Best practices for writing technical documentation, including audience research, content types, and writing tips.
- [Dropdown component](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 878 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L878

Avoid using 'will'.
</Update>

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

Check warning on line 882 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L882

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L889

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L893

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

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

Check warning on line 895 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L895

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

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

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

Check warning on line 916 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L916

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L923

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

Check warning on line 925 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L925

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

Check warning on line 925 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L925

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

## Web Editor

Check warning on line 927 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L927

'Web Editor' should use sentence-style capitalization.

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

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

Check warning on line 934 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L934

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

## /llms.txt support

Check warning on line 936 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L936

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

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

## Localization

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

Check warning on line 945 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L945

Avoid using 'will'.

### Quality Improvements

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

Check warning on line 950 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L950

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

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

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

Check warning on line 956 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L956

Use parentheses judiciously.

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

Check warning on line 961 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L961

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L966

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

Check warning on line 968 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L968

Use semicolons judiciously.
}
sayHello();
```
Expand Down