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
2 changes: 2 additions & 0 deletions changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
noindex: true
---

Hello world

<Update label="September 14 - September 19" tags={["Improvements"]} rss={{ title: "Weekly Updates", description: "GitLab integration enhancements, app router migration progress, authentication improvements, and bug fixes" }}>

## GitLab integration enhancements
Expand All @@ -20,11 +22,11 @@

## Bug fixes and reliability

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

Check warning on line 25 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L25

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

Check warning on line 27 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L27

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

Check warning on line 29 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L29

Did you really mean 'onClick'?

</Update>

Expand All @@ -34,14 +36,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 39 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L39

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L46

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 @@ -49,20 +51,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 54 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L54

Avoid using 'will'.

Check warning on line 54 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L54

Did you really mean 'prefill'?

Check warning on line 54 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L54

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L55

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L62

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

Check warning on line 62 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L62

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L64

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

Check warning on line 65 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L65

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L67

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 @@ -77,7 +79,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 82 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L82

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

## Navigation and quality of life improvements

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

Check warning on line 98 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L98

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

Check warning on line 98 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L98

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

Check warning on line 98 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L98

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L103

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L107

Did you really mean 'cdnjs'?

Check warning on line 107 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L107

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

Check warning on line 107 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L107

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

</Update>

Expand All @@ -111,18 +113,18 @@
## Image handling improvements

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

Check warning on line 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

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L121

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L127

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 @@ -134,7 +136,7 @@

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

Check warning on line 139 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L139

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

Check warning on line 139 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L139

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

</Update>

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

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

Check warning on line 148 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L148

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L149

Did you really mean 'parallelization'?

Check warning on line 149 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L149

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L151

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L157

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 @@ -161,18 +163,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 166 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L166

Did you really mean 'prepending'?

## Analytics and LLM integrations

Check warning on line 168 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L168

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

Check warning on line 168 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L168

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L170

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L172

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L177

Did you really mean 'classnames'?
- Fixed `h{1-4}` tags rendering as `Heading` components with chips in custom page mode
- Added CSS selectors to [breadcrumbs](/navigation#breadcrumbs) for custom CSS targeting
- Fixed stretched open-graph images by analyzing dimensions to maintain proportions at 56px height
Expand All @@ -182,10 +184,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 187 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L187

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

Check warning on line 188 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L188

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

Check warning on line 189 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L189

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

Check warning on line 189 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L189

Use 'path' instead of 'pathname'.

Check warning on line 189 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L189

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

Check warning on line 190 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L190

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

Check warning on line 190 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L190

Did you really mean 'sourcemaps'?

## Technical improvements

Expand All @@ -200,40 +202,40 @@

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

Check warning on line 205 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L205

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L206

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L207

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

Check warning on line 207 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L207

Did you really mean 'misconfiguration'?

## API playground enhancements

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

Check warning on line 214 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L214

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

## Assistant updates

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

Check warning on line 218 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L218

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L223

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L224

Use 'email' instead of 'Email'.

Check warning on line 224 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L224

Did you really mean 'autofocuses'?

Check warning on line 224 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L224

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L225

Use parentheses judiciously.

Check warning on line 225 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L225

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L232

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

Check warning on line 232 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L232

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

Check warning on line 233 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L233

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L235

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

Check warning on line 235 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L235

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L236

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L238

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

<Update label="July 27 - August 2" tags={["Improvements"]} rss={{ title: "Weekly Updates", description: "Authentication improvements, search enhancements, and assistant API" }}>
Expand All @@ -242,11 +244,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 247 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L247

Use parentheses judiciously.

## API playground enhancements

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

Check warning on line 251 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L251

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 @@ -258,15 +260,15 @@

## Performance and reliability

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

Check warning on line 263 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L263

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L264

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

Check warning on line 265 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L265

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L266

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L270

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

Check warning on line 271 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L271

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 @@ -274,16 +276,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 279 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L279

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L284

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L288

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 @@ -296,7 +298,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 301 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L301

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 @@ -304,10 +306,10 @@
Learn more in the [assistant docs](/guides/assistant).

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

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 'RSS', if it's unfamiliar to the audience.
- Integrate RSS-enabled updates with Slack, email, and other tools

Check warning on line 310 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L310

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

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

Check warning on line 312 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L312

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

</Update>

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

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

Check warning on line 327 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L327

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

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

Check warning on line 331 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L331

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

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

Check warning on line 334 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L334

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

Expand All @@ -338,21 +340,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 343 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L343

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L350

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L357

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

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L392

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L395

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

<Update label="February 2025" tags={["New releases", "Improvements"]}>
Expand All @@ -403,7 +405,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 408 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L408

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

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

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

## CI Checks

Check warning on line 422 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L422

'CI Checks' should use sentence-style capitalization.

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

Check warning on line 424 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L424

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L428

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

## More Themes

Check warning on line 430 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L430

'More Themes' should use sentence-style capitalization.

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

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

Check warning on line 447 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L447

Avoid using 'will'.
</Update>

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

Check warning on line 451 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L451

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L458

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L462

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L464

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 @@ -480,27 +482,27 @@
</Update>

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

Check warning on line 485 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L485

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L492

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

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

Check warning on line 494 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L494

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

Check warning on line 494 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L494

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

Check warning on line 494 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L494

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

## Web Editor

Check warning on line 496 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L496

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L503

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

## /llms.txt support

Check warning on line 505 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L505

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

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

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L514

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L519

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L525

Use parentheses judiciously.

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

Check warning on line 530 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L530

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

Expand All @@ -549,7 +551,7 @@

## Light mode code blocks

Code blocks now have a light mode variant which can be enabled by adding the following to your `docs.json`:

Check warning on line 554 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L554

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

```json
"codeBlock": {
Expand All @@ -557,7 +559,7 @@
}
```

## Advanced Footer

Check warning on line 562 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L562

'Advanced Footer' should use sentence-style capitalization.

<Frame>
![Advanced Footer](/images/changelog/advanced-footer.gif)
Expand All @@ -568,29 +570,29 @@

## Filter search based on the current user

When personalization is enabled, search results are now filtered based on the current logged in user so that they only see the relevant content.

Check warning on line 573 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L573

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

## Custom Prompts for AI Chat

Check warning on line 575 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L575

'Custom Prompts for AI Chat' should use sentence-style capitalization.

You can now customize the prompts for the AI chat. Please reach out to [support](mailto:[email protected]) if you'd like to customize the prompts.

## Dashboard Improvements

- Added ability to change custom domain to be /docs directly through dashboard settings.
- Consolidated the login and signup pages to decrease friction and confusion.

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

## Bug Fixes

Check warning on line 587 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L587

'Bug Fixes' should use sentence-style capitalization.

- Can now use leading slashes in navigation.
- Can now edit CSS & JS files in the web editor.
- Fixed `suggestEdit` not showing up even when enabled.
- Fixed keyboard navigation for Search and Chat such that you can now use the up and down arrow keys to navigate the results.
- Don't allow search engines to crawl user-auth protected pages.
- Revalidate the cache when an org is deleted.

Check warning on line 594 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L594

In general, use active voice instead of passive voice ('is deleted').
- We now use the Scalar OpenAPI parser to parse OpenAPI definitions which improves the performance, fixes parsing issues, and surfaces better error messages.

Check warning on line 595 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L595

Try to avoid using first-person plural like 'We'.
- Top-level descriptions are now supported in API reference pages autogenerated from OpenAPI definitions.
- Add in-line-style support for icons
- Fixed the pop-in of custom CSS in docs.
Expand All @@ -599,18 +601,18 @@
</Update>

<Update label="September 2024">
## Custom Fonts

Check warning on line 604 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L604

'Custom Fonts' should use sentence-style capitalization.

<Frame>
![Custom Fonts](/images/changelog/custom-fonts.jpeg)
</Frame>
Personalize the font of your docs to your own font hosted on a CDN or by choosing from Google fonts to match your docs with your brand.

## Images in Card components

Check warning on line 611 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L611

'Images in Card components' should use sentence-style capitalization.

Add an `img` property to a card to display an image on the top of the card. Learn more about it [here](/components/cards#image-card).

## Update Speed Performances

Check warning on line 615 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L615

'Update Speed Performances' should use sentence-style capitalization.

<Frame>
![Performance Improvements](/images/changelog/performance-improvements.png)
Expand All @@ -619,10 +621,10 @@
~440x faster - a 99.8% time reduction. Across the board, file downloads during
updates are now ~5.5x faster - an 81.8% time reduction.

## SEO improvements

Check warning on line 624 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L624

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

Check warning on line 624 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L624

'SEO improvements' should use sentence-style capitalization.

<Frame>
![SEO Improvements](/images/changelog/seo-improvements.jpeg)

Check warning on line 627 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L627

Spell out 'SEO', if it's unfamiliar to the audience.
</Frame>
We've fixed both the mobile and desktop layout of our docs so that they are more SEO-friendly - including adding proper aria tags to navbar and toggle elements.

Expand All @@ -630,75 +632,75 @@

- App router migration in the dashboard.
- Search analytics are now available in the dashboard.
- Delete an org functionality has been added to the dashboard.

Check warning on line 635 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L635

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

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 ('been added').
- Shipped GitLab connection UI.
- Fix incorrect analytics data.
- Add-on's can now be directly purchased through the dashboard.

## Bug Fixes

Check warning on line 640 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L640

'Bug Fixes' should use sentence-style capitalization.

- Fixed a bug where the top bar would not stretch to the width of the screen when it's in custom mode and the sidebar layout is `sidenav`.
- Fix relative positioning of the AI widget.

## More

- **Troubleshooting for API pages**: API pages could be complicated so we listed

Check warning on line 647 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L647

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

Check warning on line 647 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L647

Try to avoid using first-person plural like 'we'.
common issues to help you sort them out quickly —
[Read the docs](/api-playground/troubleshooting)
</Update>

<Update label="August 2024">
## OpenAPI Reference Pages

Check warning on line 653 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L653

'OpenAPI Reference Pages' should use sentence-style capitalization.

- Endpoints defined by OpenAPI that are complex and recursive are now 98%
smaller.
- We now show

Check warning on line 657 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L657

Try to avoid using first-person plural like 'We'.
[additionalProperties](https://swagger.io/docs/specification/data-models/dictionaries/)
in OpenAPI pages.

## File Uploads in API Playground

Check warning on line 661 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L661

'File Uploads in API Playground' should use sentence-style capitalization.

By default, API playground requests are proxied by Mintlify. Now you can use
`disableProxy` to disable this behavior and support request types like file

Check warning on line 664 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L664

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

- [Learn more about API configurations](settings#api-configurations)

## Mobile SEO improvements

Check warning on line 669 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L669

'Mobile SEO improvements' should use sentence-style capitalization.

Check warning on line 669 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L669

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

We've fixed the mobile layout of our docs so that they are more SEO-friendly -

Check warning on line 671 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L671

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

Check warning on line 671 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L671

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

Check warning on line 671 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L671

Use 'they're' instead of 'they are'.

Check warning on line 671 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L671

Spell out 'SEO', if it's unfamiliar to the audience.
including adding proper aria tags to elements.

## Support Form

We added a more detailed support form to the Mintlify dashboard. You can now

Check warning on line 676 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L676

Try to avoid using first-person plural like 'We'.
submit a form to get in touch with us.

Check warning on line 677 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L677

Use 'tap' instead of 'touch'.

Check warning on line 677 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L677

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

## Bug Fixes

Check warning on line 679 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L679

'Bug Fixes' should use sentence-style capitalization.

- Fixed a bug for the Segment integration functionality.

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'.
- We now raise more granular error messages for GitHub permissions when

Check warning on line 682 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L682

Try to avoid using first-person plural like 'We'.
interacting with the editor.
- Fixed bugs where the navigation would not properly expand when a direct link
was used.

Check warning on line 685 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L685

In general, use active voice instead of passive voice ('was used').
</Update>

<Update label="July 2024">
## AI Widget

Check warning on line 689 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L689

'AI Widget' should use sentence-style capitalization.

<Frame>
![AI Widget](/images/changelog/widget.png)
</Frame>
For `Pro` users, we introduced Mintlify Widget, an extension of your docs to

Check warning on line 694 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L694

Try to avoid using first-person plural like 'we'.
answer your users' questions when and where they asked. You can add this
AI-powered chatbot to any web page: your landing page, inside your product, or

Check warning on line 696 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L696

Did you really mean 'chatbot'?
on your existing documentation pages.

- [Read the blog announcement](https://mintlify.com/blog/widget)

## Pro Plan

Check warning on line 701 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L701

'Pro Plan' should use sentence-style capitalization.

We also updated our pricing plans for better customizability and scale.

Check warning on line 703 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L703

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

Check warning on line 703 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L703

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

- [Read the blog announcement](https://mintlify.com/blog/pro-plan)

Expand All @@ -714,21 +716,21 @@
</Update>

<Update label="June 2024">
## Launch Week Highlights

Check warning on line 719 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L719

'Launch Week Highlights' should use sentence-style capitalization.

- Themes: Customize your styling with pre-configured themes. Just add the theme Quill, Prism, or Venus to your `docs.json` file and it'll update your docs styling.
- Search V2: directly query OpenAPI endpoint descriptions and titles to reach API Reference pages, remove hidden pages from search, and enjoy our updated search bar UI.

Check warning on line 722 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L722

Try to avoid using first-person plural like 'our'.
- Web Editor branching: create branches in our web editor without an IDE.

Check warning on line 723 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L723

Try to avoid using first-person plural like 'our'.
- User Personalization: authenticate users with Shared Session or JWT so that you can show them customized content, such as pre-filling API keys or showing specific content for customers.

Check warning on line 724 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L724

Spell out 'JWT', if it's unfamiliar to the audience.
- OpenAPI Automation Upgrades: to auto-populate API Playground pages, you can add an `openapi` field to an object in tabs or anchors arrays in the `docs.json`.
</Update>

<Update label="May 2024">
## Okta SSO

Check warning on line 729 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L729

'Okta SSO' should use sentence-style capitalization.

Check warning on line 729 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L729

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

We now support sign-on via Okta SAML and OIDC.

Check warning on line 731 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L731

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

Check warning on line 731 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L731

Use 'single sign-on' instead of 'sign-on'.

Check warning on line 731 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L731

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

Check warning on line 731 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L731

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

## Mintlify REST API

Check warning on line 733 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L733

'Mintlify REST API' should use sentence-style capitalization.

Check warning on line 733 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L733

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

Programmatically rigger updates to your documentation.
</Update>
Expand All @@ -743,13 +745,13 @@
- Add full-screen videos or image galleries
- Embed custom iFrame demo elements to add intractability to your docs

Check out our [Custom Mode docs](pages#custom-mode).

Check warning on line 748 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L748

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

<Update label="March 2024">
## Mintlify MDX for VSCode

Check warning on line 752 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L752

'Mintlify MDX for VSCode' should use sentence-style capitalization.

Call snippets of our pre-built components and callouts without leaving VSCode. [Install the extension here](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets).

Check warning on line 754 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L754

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

<Update label="February 2024">
Expand All @@ -758,14 +760,14 @@
- Dashboard upgrades: view update logs to see what's changed and status of an update, toggle between Mintlify projects to manage deployments
- Versioning with tabs fully supported
- Wildcard redirects now supported
- CLI Error Detection: we now show the position of invalid frontmatter when there are parsing issues during local development

Check warning on line 763 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L763

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

Check warning on line 763 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L763

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

<Update label="January 2024">
## Launch Week Highlights

Check warning on line 767 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L767

'Launch Week Highlights' should use sentence-style capitalization.

- Preview Deployments: When you create a pull request, we'll generate a unique link that shows a live preview of what your docs look like in prod. You can share this link with teammates.

Check warning on line 769 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L769

Try to avoid using first-person plural like 'we'.
- Snippets V2: We now support fully reusable components and variables for snippets.

Check warning on line 770 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L770

Try to avoid using first-person plural like 'We'.
- 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.

Check warning on line 771 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

changelog.mdx#L771

Try to avoid using first-person plural like 'We'.
- 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>
2 changes: 2 additions & 0 deletions index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
mode: "custom"
---

Hello world

export const HeroCard = ({ filename, title, description, href }) => {
return (
<a className="group cursor-pointer pb-8" href={href}>
Expand All @@ -21,8 +23,8 @@
</h3>
<span className="mt-1.5">{description}</span>
</a>
);

Check warning on line 26 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L26

Use semicolons judiciously.
};

Check warning on line 27 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L27

Use semicolons judiciously.

<div className="relative">
<div className="absolute top-0 lg:-top-16 left-0 right-0">
Expand Down
2 changes: 2 additions & 0 deletions installation.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
title: "CLI installation"

Check warning on line 2 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L2

Use 'command-line tool' instead of 'CLI'.
sidebarTitle: "Installation"
description: "Install the CLI to preview and develop your docs locally"

Check warning on line 4 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L4

Use 'command-line tool' instead of 'CLI'.
icon: "terminal"
---

Hello world

<img
className="block dark:hidden my-0 pointer-events-none"
src="/images/installation/local-development-light.png"
Expand All @@ -14,10 +16,10 @@
src="/images/installation/local-development-dark.png"
/>

## Installing the CLI

Check warning on line 19 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L19

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

<Info>
**Prerequisite**: Please install [Node.js](https://nodejs.org/en) before proceeding.

Check warning on line 22 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L22

': P' should be in lowercase.
</Info>

<Steps>
Expand All @@ -36,7 +38,7 @@

</Step>
<Step title="Preview locally.">
Navigate to your docs directory (where your `docs.json` file is located) and execute the following command:

Check warning on line 41 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L41

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

```bash
mint dev
Expand All @@ -46,7 +48,7 @@
</Step>
</Steps>

Alternatively, if you do not want to install the CLI globally, you can run a one-time script:

Check warning on line 51 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L51

Use 'don't' instead of 'do not'.

Check warning on line 51 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L51

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

```bash
npx mint dev
Expand All @@ -54,13 +56,13 @@

## Updates

If your local preview is out of sync with what you see on the web in the production version, update your local CLI:

Check warning on line 59 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L59

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

```bash
mint update
```

If this `mint update` command is not available on your local version, re-install the CLI with the latest version:

Check warning on line 65 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L65

Use 'isn't' instead of 'is not'.

Check warning on line 65 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L65

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

<CodeGroup>
```bash npm
Expand All @@ -74,13 +76,13 @@

## Custom ports

By default, the CLI uses port 3000. You can customize the port using the `--port` flag. To run the CLI on port 3333, for instance, use this command:

Check warning on line 79 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L79

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

Check warning on line 79 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L79

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

```bash
mint dev --port 3333
```

If you attempt to run on a port that is already in use, it will use the next available port:

Check warning on line 85 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L85

Use 'that's' instead of 'that is'.

Check warning on line 85 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L85

Avoid using 'will'.

```mdx
Port 3000 is already in use. Trying 3001 instead.
Expand All @@ -102,7 +104,7 @@

### Finding broken links

The CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command:

Check warning on line 107 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L107

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

```bash
mint broken-links
Expand All @@ -110,13 +112,13 @@

### Checking OpenAPI spec

You can use the CLI to check your OpenAPI file for errors using the following command:

Check warning on line 115 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L115

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

```bash
mint openapi-check <openapiFilenameOrUrl>
```

You can pass in a filename (for example, `./openapi.yaml`) or a URL (for example, `https://petstore3.swagger.io/api/v3/openapi.json`).

Check warning on line 121 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L121

Use parentheses judiciously.

### Renaming files

Expand All @@ -138,11 +140,11 @@

## Formatting

While developing locally, we recommend using extensions in your IDE to recognize and format `MDX` files.

Check warning on line 143 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L143

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

If you use Cursor, Windsurf, or VS Code, we recommend the [MDX VS Code extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting.

Check warning on line 145 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L145

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

If you use JetBrains, we recommend the [MDX IntelliJ IDEA plugin](https://plugins.jetbrains.com/plugin/14944-mdx) for syntax highlighting, and setting up [Prettier](https://prettier.io/docs/webstorm) for code formatting.

Check warning on line 147 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L147

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

## Troubleshooting

Expand All @@ -155,7 +157,7 @@
3. Reinstall the mint CLI: `npm install -g mint`
</Accordion>
<Accordion title="Issue: Encountering an unknown error">
**Solution**: Go to the root of your device and delete the `~/.mintlify` folder. Afterwards, run `mint dev` again.

Check warning on line 160 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L160

': G' should be in lowercase.
</Accordion>
<Accordion title="Error: permission denied">
This is due to not having the required permissions to globally install node packages.
Expand All @@ -163,12 +165,12 @@
**Solution**: Try running `sudo npm i -g mint`. You will be prompted for your password, which is the one you use to unlock your computer.
</Accordion>
<Accordion title="The local preview doesn't look the same as my docs do on the web">
This is likely due to an outdated version of the CLI.

Check warning on line 168 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L168

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

**Solution:** Run `mint update` to get the latest changes.

Check warning on line 170 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L170

': R' should be in lowercase.
</Accordion>
<Accordion title="mintlify vs. mint package">
If you have any problems with the CLI package, you should first run `npm ls -g`. This command shows what packages are globally installed on your machine.

Check warning on line 173 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L173

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

If you don't use npm or don't see it in the -g list, try `which mint` to locate the installation.

Expand Down
2 changes: 2 additions & 0 deletions navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
icon: "map"
---

Hello world

The [navigation](settings#param-navigation) property in `docs.json` controls the structure and information hierarchy of your documentation.

With proper navigation configuration, you can organize your content so that users can find exactly what they're looking for.
Expand All @@ -30,10 +32,10 @@
{
"navigation": {
"pages": [
"settings",

Check warning on line 35 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L35

Commas and periods go inside quotation marks.
"pages",

Check warning on line 36 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L36

Commas and periods go inside quotation marks.
"navigation",

Check warning on line 37 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L37

Commas and periods go inside quotation marks.
"themes",

Check warning on line 38 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L38

Commas and periods go inside quotation marks.
"custom-domain"
]
}
Expand Down Expand Up @@ -247,9 +249,9 @@
}
```

For anchors that direct to external links only, use the `global` keyword. Anchors in a `global` object must have an `href` field and cannot point to a relative path.

Check warning on line 252 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L252

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

Global anchors are particularly useful for linking to resources that are not part of your documentation, but should be readily accessible to your users like a blog or support portal

Check warning on line 254 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L254

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

```json
{
Expand All @@ -275,7 +277,7 @@

## Dropdowns

Dropdowns are contained in an expandable menu at the top of your sidebar navigation. Each item in a dropdown directs to a section of your documentation.

Check warning on line 280 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L280

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

<img
className="block dark:hidden pointer-events-none"
Expand Down Expand Up @@ -324,7 +326,7 @@

Integrate OpenAPI specifications directly into your navigation structure to automatically generate API documentation. Create dedicated API sections or place endpoint pages within other navigation components.

Set a default OpenAPI specification at any level of your navigation hierarchy. Child elements will inherit this specification unless they define their own specification.

Check warning on line 329 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L329

Avoid using 'will'.

```json
{
Expand Down Expand Up @@ -414,7 +416,7 @@

In the `navigation` object, `languages` is an array where each entry is an object that requires a `language` field and can contain any other navigation fields.

We currently support the following languages for localization:

Check warning on line 419 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L419

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

<CardGroup cols={2}>
<Card title="Arabic (ar)" icon={<img src="https://mintlify.s3.us-west-1.amazonaws.com/mintlify/images/navigation/languages/ar.png" className="w-6 h-6 my-0" />} horizontal />
Expand Down Expand Up @@ -464,7 +466,7 @@

## Nesting

You can use any combination of anchors, tabs, and dropdowns. The components can be nested within each other interchangeably to create your desired navigation structure.

Check warning on line 469 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L469

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

<CodeGroup>

Expand Down Expand Up @@ -586,7 +588,7 @@

## Breadcrumbs

Breadcrumbs display the full navigation path at the top of pages. Some themes have breadcrumbs enabled by default and others do not. You can control whether breadcrumbs are enabled for your site using the `styling` property in your `docs.json`.

Check warning on line 591 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L591

Use 'don't' instead of 'do not'.

Check warning on line 591 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L591

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

<CodeGroup>

Expand All @@ -610,10 +612,10 @@

### Enable auto-navigation for groups

When a user expands a navigation group, some themes will automatically navigate to the first page in the group. You can override a theme's default behavior using the `drilldown` option.

Check warning on line 615 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L615

Avoid using 'will'.

- Set to `true` to force automatic navigation to the first page when a navigation group is selected.

Check warning on line 617 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L617

In general, use active voice instead of passive voice ('is selected').
- Set to `false` to prevent navigation and only expand or collapse the group when it is selected.

Check warning on line 618 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L618

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

Check warning on line 618 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L618

In general, use active voice instead of passive voice ('is selected').
- Leave unset to use the theme's default behavior.

<CodeGroup>
Expand Down
2 changes: 2 additions & 0 deletions pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
keywords: ["tags", "tag"]
---

Hello world

Each page is an MDX file, which combines Markdown content with React components to let you create rich, interactive documentation.

## Page metadata
Expand All @@ -21,7 +23,7 @@
</ResponseField>

<ResponseField name="description" type="string">
A brief description of what this page covers. Appears under the title and improves SEO.

Check warning on line 26 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

pages.mdx#L26

Spell out 'SEO', if it's unfamiliar to the audience.
</ResponseField>

<ResponseField name="sidebarTitle" type="string">
Expand Down Expand Up @@ -64,7 +66,7 @@

### Default

If no mode is defined, defaults to a standard layout with a sidebar navigation and table of contents.

Check warning on line 69 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

pages.mdx#L69

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

```yaml
---
Expand All @@ -74,7 +76,7 @@

### Wide

Wide mode hides the table of contents. This is useful for pages that do not have any headings or if you prefer to use the extra horizontal space. Wide mode is available for all themes.

Check warning on line 79 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

pages.mdx#L79

Use 'don't' instead of 'do not'.

```yaml
---
Expand All @@ -85,7 +87,7 @@

### Custom

Custom mode provides a minimalist layout that removes all elements except for the top navbar. Custom mode is a blank canvas to create landing pages or any other unique layouts that you want to have minimal navigation elements for. Custom mode is available for all themes.

Check warning on line 90 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

pages.mdx#L90

Did you really mean 'navbar'?

```yaml
---
Expand Down Expand Up @@ -141,10 +143,10 @@

## Search engine optimization

Most SEO meta tags are automatically generated. You can set SEO meta tags manually to improve your site's SEO, social sharing, and browser compatibility.

Check warning on line 146 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

pages.mdx#L146

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

Check warning on line 146 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

pages.mdx#L146

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

Check warning on line 146 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

pages.mdx#L146

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

<Note>
Meta tags with colons must be wrapped in quotes.

Check warning on line 149 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

pages.mdx#L149

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

```yaml
Expand All @@ -153,11 +155,11 @@
---
```

See [SEO](/settings/seo) for complete SEO metadata options.

Check warning on line 158 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

pages.mdx#L158

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

## Internal search keywords

Enhance a specific page's discoverability in the built-in search by providing `keywords` in your metadata. These keywords won't appear as part of the page content or in search results, but users that search for them will be shown the page as a result.

Check warning on line 162 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

pages.mdx#L162

Avoid using 'will'.

Check warning on line 162 in pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

pages.mdx#L162

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

```yaml
---
Expand Down
2 changes: 2 additions & 0 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@
icon: "rocket"
---

Hello world

This quickstart guide shows you how to set up and deploy your documentation site in minutes.

After completing this guide, you will have a live documentation site ready to customize and expand.

Check warning on line 11 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L11

Avoid using 'will'.

<Info>

**Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding.

Check warning on line 15 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L15

': B' should be in lowercase.

</Info>

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

Your site's URL is available immediately. Use this URL for testing and sharing with your team while you are setting up your docs site.

### Install the GitHub App

Check warning on line 36 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L36

'Install the GitHub App' should use sentence-style capitalization.

Mintlify provides a GitHub App that automates deployment when you push changes to your repository.

Expand All @@ -55,11 +57,11 @@
### Authorize your GitHub account

1. Navigate to **Settings** in your Mintlify dashboard.
2. Select **My Profile** from the sidebar.

Check warning on line 60 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L60

Avoid first-person pronouns such as 'My'.
3. Select **Authorize GitHub account**. This opens a new tab to the GitHub authorization page.

<Info>
An admin for your GitHub organization may need to authorize your account depending on your organization settings.

Check warning on line 64 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L64

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

## Editing workflows
Expand All @@ -78,9 +80,9 @@

The code-based workflow integrates with your existing development environment and Git repositories. This workflow is best for technical teams who want to manage documentation alongside code.

### Install the CLI

Check warning on line 83 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L83

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

To work locally with your documentation, install the Command Line Interface (CLI), called [mint](https://www.npmjs.com/package/mint), by running this command in your terminal:

Check warning on line 85 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L85

Use parentheses judiciously.

Check warning on line 85 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L85

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

<CodeGroup>
```bash npm
Expand Down Expand Up @@ -127,7 +129,7 @@
mint dev
```

Your preview will be available at `localhost:3000`.

Check warning on line 132 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L132

Avoid using 'will'.

<Frame>
<img src="/images/quickstart/mintlify-dev-light.png" alt="Mintlify Dev" className="block dark:hidden" />
Expand All @@ -140,7 +142,7 @@

Mintlify automatically detects the changes, builds your documentation, and deploys the updates to your site. Monitor the deployment status in your GitHub repository commit history or the [dashboard](https://dashboard.mintlify.com).

After the deployment completes, your latest update will be available at `<your-project-name>.mintlify.app`.

Check warning on line 145 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L145

Avoid using 'will'.

<Card title="Jump to adding a custom domain" icon="arrow-down" href="#adding-a-custom-domain" horizontal>
Optionally, skip the web editor workflow and jump to adding a custom domain.
Expand All @@ -148,7 +150,7 @@

## Web editor workflow

The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interface for creating and editing documentation. This workflow is best for people who want to work in their web browser without additional local development tools.

Check warning on line 153 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L153

Use parentheses judiciously.

### Access the web editor

Expand All @@ -156,7 +158,7 @@
2. Select **Editor** on the left sidebar.

<Info>
If you have not installed the GitHub App, you will be prompted to install the app when you open the web editor.

Check warning on line 161 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L161

Use 'haven't' instead of 'have not'.

Check warning on line 161 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L161

Avoid using 'will'.

Check warning on line 161 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L161

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

<Frame>
Expand All @@ -166,11 +168,11 @@

### Edit the documentation

In the web editor, you can navigate through your documentation files in the sidebar. Let's update the introduction page:

Check warning on line 171 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L171

Try to avoid using first-person plural like 'Let's'.

Find and select `index.mdx` in the file explorer.

Then, in the editor, update the title field to "Hello World".

Check warning on line 175 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L175

Commas and periods go inside quotation marks.

<Frame>
<img alt="Editing in Web Editor" src="/images/quickstart/web-editor-editing-light.png" className="block dark:hidden" />
Expand All @@ -189,7 +191,7 @@
Use branches to preview and review changes through pull requests before deploying to your live site.
</Tip>

For more details about using the web editor, including using branches and pull requests to collaborate and preview changes, see our [web editor documentation](/editor/getting-started).

Check warning on line 194 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L194

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

## Adding a custom domain

Expand All @@ -202,21 +204,21 @@
<img src="/images/quickstart/custom-domain-dark.png" alt="Custom Domain" className="hidden dark:block" />
</Frame>

Enter your domain (for example, `docs.yourcompany.com`) and follow the provided instructions to configure DNS settings with your domain provider.

Check warning on line 207 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L207

Use parentheses judiciously.

<Table>
| Record Type | Name | Value | TTL |
|-------------|------|-------|-----|
| CNAME | docs (or subdomain) | cname.mintlify.app | 3600 |

Check warning on line 212 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L212

Use parentheses judiciously.
</Table>

<Info>
DNS changes can take up to 48 hours to propagate, though changes often complete much sooner.
</Info>

## Next steps

Check warning on line 219 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L219

'Next steps' should use sentence-style capitalization.

Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation:

Check warning on line 221 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L221

Don't use exclamation points in text.

Check warning on line 221 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L221

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

<Card title="Configure your global settings" icon="settings" href="settings" horizontal>
Configure site-wide styling, navigation, integrations, and more with the `docs.json` file.
Expand Down Expand Up @@ -246,6 +248,6 @@
Deployment can take upwards to a few minutes. Check your GitHub Actions (for code-based workflow) or deployment logs in the Mintlify dashboard to ensure there are no build errors.
</Accordion>
<Accordion title="Custom domain not connecting">
Verify that your DNS records are set up correctly and allow sufficient time for DNS propagation (up to 48 hours). You can use tools like [DNSChecker](https://dnschecker.org) to verify your CNAME record.

Check warning on line 251 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L251

In general, use active voice instead of passive voice ('are set').
</Accordion>
</AccordionGroup>
2 changes: 2 additions & 0 deletions settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
keywords: ["docs.json", "settings", "customization", "configuration"]
---

Hello world

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

The `docs.json` file lets you turn a collection of Markdown files into a navigable, customized documentation site. This required configuration file controls styling, navigation, integrations, and more. Think of it as the blueprint for your documentation.
Expand All @@ -20,8 +22,8 @@
```json
{
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",

Check warning on line 25 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L25

Commas and periods go inside quotation marks.
"name": "Your Docs",

Check warning on line 26 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L26

Commas and periods go inside quotation marks.
"colors": {
"primary": "#ff0000"
},
Expand Down Expand Up @@ -1449,7 +1451,7 @@

</CodeGroup>

If you already have the CLI installed, make sure it is up to date:

Check warning on line 1454 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L1454

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

Check warning on line 1454 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L1454

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

```bash
mint update
Expand All @@ -1463,7 +1465,7 @@
mint upgrade
```

This command will create a `docs.json` file from your existing `mint.json`. Review the generated file to ensure all settings are correct.

Check warning on line 1468 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L1468

Avoid using 'will'.
</Step>
<Step title="Delete your mint.json file">
After verifying your `docs.json` is configured properly, you can safely delete your old `mint.json` file.
Expand Down
2 changes: 2 additions & 0 deletions themes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
mode: "custom"
---

Hello world

export const ThemeCard = ({ title, value, description, href }) => {
return (
<a className="mt-4 gap-10 group cursor-pointer" href={href}>
Expand All @@ -28,8 +30,8 @@
</div>
</div>
</a>
);

Check warning on line 33 in themes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

themes.mdx#L33

Use semicolons judiciously.
};

Check warning on line 34 in themes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

themes.mdx#L34

Use semicolons judiciously.

<div className="pt-10 pb-24 px-4 px-4 max-w-3xl mx-auto prose prose-gray">
<label className="eyebrow h-5 text-primary dark:text-primary-light text-sm font-semibold">Core Concepts</label>
Expand Down
Loading