Fix vale errors

.vale.ini

@@ -22,7 +22,8 @@ Vale.Avoid = NO # Too aggressive about common technical terms
 # Token and block ignores for MDX-specific syntax
 TokenIgnores = (?sm)((?:import|export) .+?$), \
 (?<!`)(<\w+ ?.+ ?\/>)(?!`), \
-(<[A-Z]\w+>.+?<\/[A-Z]\w+>)
+(<[A-Z]\w+>.+?<\/[A-Z]\w+>), \
+(<[^>]*>)
 
 BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
 (?sm)^({.+.*})

.vale/styles/Google/Quotes.yml

@@ -4,4 +4,5 @@ link: 'https://developers.google.com/style/quotation-marks'
 level: error
 nonword: true
 tokens:
-  - '"[^"]+"[.,?]'
+  # Match quotes with trailing punctuation, but exclude content in JSON
+  - '(?<!^\s*)"[^"]+"[.,?](?!\s*$)'

.vale/styles/config/vocabularies/Mintlify/accept.txt

@@ -8,83 +8,87 @@ bearerAuth
 borderRadius
 camelCase
 discoverability
-callout
-Callouts
-callouts
+(?i)callouts?
 drilldown
 expandables
 favicon
 isHidden
-Mintlify
-mintlify
-modeToggle
-ModeToggle
+(?i)mintlify
+(?i)modetoggle
 myName
 myObject
 onboarding
-openapi
-OpenAPI
+(?i)openapi
 repo
 topbar
-tooltip
-Tooltip
-tooltips
+(?i)tooltips?
 url
 
 # =============================================================================
-# PROGRAMMING LANGUAGES & FRAMEWORKS
+# NAMES OF THINGS
 # =============================================================================
 Angular
 AWS
 Azure
-Babel
-babel
+(?i)babel
 Bitbucket
+(?i)chatgpt
+(?i)claude
+CloudFront
 Chromium
 CircleCI
+Clearbit
+Ctrl
 Cypress
 Django
 DynamoDB
 Elasticsearch
-ESLint
-eslint
+Entra
+(?i)eslint
 Express
 Firefox
 Flask
 GCP
-Git
-git
+(?i)git
 GitHub
 GitLab
 Go
 Golang
 GraphQL
 Heroku
+Hightouch
 IntelliJ
 Java
 JavaScript
-Jest
-jest
+(?i)jest
 JSDoc
 Kotlin
 Kubernetes
 Laravel
 Linux
+LLMs
+Lucide
 macOS
+(?i)mcp
 MDX
+Mixpanel
 Mocha
 MongoDB
 MySQL
 Next.js
 Node.js
 NodeJS
+npx
 Nuxt
 OAuth
+Okta
+Osano
+Pirsch
 PNPM
+Posthog
 Postman
 PostgreSQL
-Prettier
-prettier
+(?i)prettier
 Python
 React
 Redis
@@ -100,27 +104,29 @@ Terraform
 TypeDoc
 TypeScript
 Unix
-Vercel
-vercel
-Vite
-vite
+(?i)vercel
+(?i)vite
 Visual Studio Code
 VS Code
+vscode
 Vue
 Vuex
 Webflow
 WebKit
-Webpack
-webpack
+(?i)webpack
 WebStorm
+Zapier
 
 # =============================================================================
 # TERMS
 # =============================================================================
+agentic
 allowlist
 APIs
 args
 async
+autogenerated
+autogenerating
 await
 bool
 boolean
@@ -145,14 +151,18 @@ elem
 enum
 env
 err
+favicons
 func
+frontmatter
+Gantt
 gui
 href
 html
 http
 https
 ide
 impl
+ingestible
 init
 instanceof
 jvm
@@ -164,6 +174,7 @@ md
 middleware
 Multiline
 mvc
+monorepo
 nav
 next
 nodejs
@@ -175,16 +186,22 @@ orm
 params
 pnpm
 png
+prepend
+prepended
 prev
 proc
+proxied
+proxying
 ptr
 pytest
 req
 res
 rpc
 runtime
 scss
+SDKs
 sdk
+serverless
 Singleline
 sql
 ssh
@@ -194,16 +211,23 @@ stdin
 stdout
 Strikethrough
 struct
+subpaths
+subschema
+Subscribable
+subscribable
+SVGs
 svg
 tcp
 tls
 tmp
 toc
 todo
+transpilation
 tsx
 TTL
 typeof
 ui
+uncached
 undefined
 uri
 ux
@@ -217,3 +241,10 @@ xhr2
 yaml
 yarn
 yml
+
+# =============================================================================
+# LOCALIZATION
+# =============================================================================
+cn
+ko
+ru

advanced/dashboard/sso.mdx

@@ -1,25 +1,25 @@
 ---
 title: "Single sign-on (SSO)"
 description: "Customize how your team can login to your admin dashboard"
 ---
 
 <Info>
   SSO functionality is available on [Enterprise plan](https://mintlify.com/pricing?ref=sso).
 </Info>
 
 Use single sign-on to your dashboard via SAML and OIDC. If you use Okta, Google Workspace, or Microsoft Entra, we have provider-specific documentation for setting up SSO. If you use another provider, please [contact us](mailto:support@mintlify.com).
 
 ## Okta
 
 <Tabs>
     <Tab title="SAML">
         <Steps>
             <Step title="Create an application">
                 Under `Applications`, click to create a new app integration using SAML 2.0.
             </Step>
             <Step title="Configure integration">
                 Enter the following:
                 * Single sign-on URL (provided by Mintlify)
                 * Audience URI (provided by Mintlify)
                 * Name ID Format: `EmailAddress`
                 * Attribute Statements:
@@ -28,13 +28,13 @@
                     | `firstName` | Basic | `user.firstName` |
                     | `lastName` | Basic | `user.lastName` |
             </Step>
             <Step title="Send us your IdP information">
                 Once the application is set up, navigate to the sign-on tab and send us the metadata URL.
                 We'll enable the connection from our side using this information.
             </Step>
         </Steps>
     </Tab>
     <Tab title="OIDC">
         <Steps>
             <Step title="Create an application">
                 Under `Applications`, click to create a new app integration using OIDC.
@@ -44,14 +44,14 @@
                 Select the authorization code grant type and enter the Redirect URI provided by Mintlify.
             </Step>
             <Step title="Send us your IdP information">
                 Once the application is set up, navigate to the General tab and locate the client ID & client secret.
-                Please securely provide us with these, along with your Okta instance URL (e.g. `<your-tenant-name>.okta.com`). You can send these via a service like 1Password or SendSafely.
+                Please securely provide us with these, along with your Okta instance URL (for example, `<your-tenant-name>.okta.com`). You can send these via a service like 1Password or SendSafely.
             </Step>
         </Steps>
     </Tab>
 </Tabs>
 
 ## Google Workspace
 
 <Tabs>
     <Tab title="SAML">
@@ -63,14 +63,14 @@
                 </Frame>              
             </Step>
             <Step title="Send us your IdP information">
                 Copy the provided SSO URL, Entity ID, and x509 certificate and send it to the Mintlify team.
                 <Frame>
                     ![](/images/gsuite-saml-metadata.png)                    
                 </Frame>
             </Step>
             <Step title="Configure integration">
                 On the Service provider details page, enter the following:
                 * ACS URL (provided by Mintlify)
                 * Entity ID (provided by Mintlify)
                 * Name ID format: `EMAIL`
                 * Name ID: `Basic Information > Primary email`
@@ -94,16 +94,16 @@
 ## Microsoft Entra
 
 <Tabs>
     <Tab title="SAML">
         <Steps>
             <Step title="Create an application">
-                1. Under "Enterprise applications", select **New application**.
+                1. Under "Enterprise applications," select **New application**.
                 2. Select **Create your own application** and choose "Integrate any other application you don't find in the gallery (Non-gallery)."
             </Step>
             <Step title="Configure SAML">
                 Navigate to the Single Sign-On setup page and select **SAML**. Under "Basic SAML Configuration," enter the following:
                 * Identifier (Entity ID): The Audience URI provided by Mintlify.
                 * Reply URL (Assertion Consumer Service URL): The ACS URL provided by Mintlify.
 
                 Leave the other values blank and select **Save**.
             </Step>

advanced/subpath/route53-cloudfront.mdx

@@ -10,13 +10,13 @@
 
 ## Repository structure
 
 Your documentation files must be organized within your repository to match your chosen subpath structure. For example, if you want your documentation at `yoursite.com/docs`, you would create a `docs/` directory with all of your documentation files.
 
 ## High-level overview
 
 Route traffic to these paths with a Cache Policy of **CachingDisabled**:
 
 - `/.well-known/acme-challenge/*` - Required for Let's Encrypt certificate verification
 - `/.well-known/vercel/*` - Required for domain verification
 - `/docs/*` - Required for subpath routing
 - `/docs/` - Required for subpath routing
@@ -45,10 +45,10 @@
     ![CloudFront "Create distribution" page showing "acme.mintlify.dev" as the origin domain.](/images/cloudfront/origin-name.png)
   </Frame>
 
 4. For "Web Application Firewall (WAF)," enable security protections.
 
   <Frame>
     ![Web Application Firewall (WAF) options with "Enable security protections" selected.](/images/cloudfront/enable-security-protections.png)
   </Frame>
 
 5. The remaining settings should be default.
@@ -62,15 +62,15 @@
     ![A CloudFront distribution with the "Origins" tab highlighted.](/images/cloudfront/origins.png)
   </Frame>
 
 2. Find your staging URL that mirrors the main domain. This is highly variant depending on how your landing page is hosted. For example, the Mintlify staging URL is [mintlify-landing-page.vercel.app](https://mintlify-landing-page.vercel.app).
 
 <Info>
   If your landing page is hosted on Webflow, use Webflow's staging URL. It would look like `.webflow.io`.
 
   If you use Vercel, use the `.vercel.app` domain available for every project.
 </Info>
 
-3. Create a new Origin and add your staging URL as the "Origin domain".
+3. Create a new Origin and add your staging URL as the "Origin domain."
 
   <Frame>
     ![CloudFront "Create origin" page with a "Origin domain" input field highlighted.](/images/cloudfront/default-origin.png)
@@ -84,7 +84,7 @@
 
 ## Set behaviors
 
 Behaviors in CloudFront enable control over the subpath logic. At a high level, we're looking to create the following logic:
 
 - **If a user lands on your custom subpath**, go to `[SUBDOMAIN].mintlify.dev`.
 - **If a user lands on any other page**, go the current landing page.
@@ -101,21 +101,21 @@
 
 Create behaviors for Vercel domain verification paths with a **Path pattern** of `/.well-known/*` and set **Origin and origin groups** to your docs URL.
 
-For "Cache policy", select **CachingDisabled** to ensure these verification requests pass through without caching.
+For "Cache policy," select **CachingDisabled** to ensure these verification requests pass through without caching.
 
 <Frame>
   ![CloudFront "Create behavior" page with a "Path pattern" of "/.well-known/*" and "Origin and origin groups" pointing to the staging URL.](/images/cloudfront/well-known-policy.png)
 </Frame>
 
 <Info>
 If `.well-known/*` is too generic, it can be narrowed down to 2 behaviors at a minimum for Vercel:
   - `/.well-known/vercel/*` - Required for Vercel domain verification
   - `/.well-known/acme-challenge/*` - Required for Let's Encrypt certificate verification
 </Info>
 
 ### Your custom subpath
 
 Create a behavior with a **Path pattern** of your chosen subpath, for example `/docs`, with **Origin and origin groups** pointing to the `.mintlify.dev` URL (in our case `acme.mintlify.dev`).
 
 - Set "Cache policy" to **CachingOptimized**.
 - Set "Origin request policy" to **AllViewerExceptHostHeader**.
@@ -143,13 +143,13 @@
 
 ### `Default (*)`
 
 Lastly, we're going to edit the `Default (*)` behavior.
 
 <Frame>
   ![A CloudFront distribution with the "Default (*)" behavior selected and the Edit button emphasized.](/images/cloudfront/default-behavior-1.png)
 </Frame>
 
 1. Change the default behavior's **Origin and origin groups** to the staging URL (in our case `mintlify-landing-page.vercel.app`).
 
 <Frame>
   ![CloudFront "Edit behavior" page with the "Origin and origin groups" input field highlighted.](/images/cloudfront/default-behavior-2.png)
@@ -157,9 +157,9 @@
 
 2. Select **Save changes**.
 
 ### Check behaviors are set up correctly
 
 If you follow the above steps, your behaviors should look like this:
 
 <Frame>
   ![CloudFront "Behaviors" page with 4 behaviors: `/docs/*`, `/docs`, `Default`, and `/.well-known/*`.](/images/cloudfront/all-behaviors.png)
@@ -167,7 +167,7 @@
 
 ## Preview distribution
 
 You can now test if your distribution is set up properly by going to the "General" tab and visiting the **Distribution domain name** URL.
 
 <Frame>
   ![CloudFront "General" tab with the "Distribution domain name" URL highlighted.](/images/cloudfront/preview-distribution.png)
@@ -175,9 +175,9 @@
 
 All pages should be directing to your main landing page, but if you append your chosen subpath, for example `/docs`, to the URL, you should see it going to your Mintlify documentation instance.
 
 ## Connect with Route53
 
 Now, we're going to bring the functionality of the CloudFront distribution into your primary domain.
 
 <Note>
   For this section, you can also refer to AWS's official guide on [Configuring

changelog.mdx

@@ -11,14 +11,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._
 
 ## 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
 - Fixed a bug where assistant spend values could display with greater than two decimal places in the dashboard
 
 ## Web editor and deployments
@@ -26,20 +26,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
 - Fixed a bug where copying a page from the context menu was not working on safari 
 
 ## 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
 
 - Fixed a bug where favicons were not showing up in search engines by serving them from the same URL as the documentation site itself for each respective site
 - Fixed a bug where youtube embeds would flash in and out on load
 - Fixed a bug where expanding the feedback menu to include written responses would cause layout shift with the table of contents
 - Fixed a bug where text would leak above the topbar on the maple theme when a dismissed the notification banner
 - Enhanced the Maple and Willow themes by adding login/logout buttons to the sidebar for easier access 
 
 ## Analytics and exports
@@ -54,7 +54,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._
 
 ## Navigation and quality of life improvements
 
@@ -70,16 +70,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  
 
 ## 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
 
 ## Performance improvements
 
 - Performance improvement by moving the KaTeX CSS from cdnjs to our own CDN on Cloudfront for reduced latency
 
 </Update>
 
@@ -88,18 +88,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
 
 ## 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
 - 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
 - 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
@@ -111,7 +111,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
 
 </Update>
 
@@ -120,16 +120,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)
 - Preview deployment viewing in the dashboard is now faster with added database indexes and query parallelization in our backend
 - 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
 
 ## 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.
 - 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
 
@@ -138,18 +138,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
 
 ## Analytics and LLM integrations
 
 - Custom `llms.txt` and `llms-full.txt` support—add to docs repo root to serve at `/llms.txt` and `/llms-full.txt` endpoints for LLM customization
 - Added [Hightouch analytics integration](/integrations/analytics/hightouch#hightouch)
 - Enhanced context menu analytics tracking (dashboard viewing coming soon)
 - 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
 - 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
@@ -159,10 +159,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
 - Fixed custom `docs.json` open-graph metatags being overwritten by generated ones
 - Fixed RSS feed button clicks when landing on anchor links by using origin + pathname for RSS links
 - Improved CLI download speed by removing sourcemaps
 
 ## Technical improvements
 
@@ -177,40 +177,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
   - Fixed a flash of a 500 error during OAuth/JWT flows before the callback
   - Auto-strip `https://` from URLs in OAuth/JWT auth configuration to prevent misconfiguration
 
   ## 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 (e.g. `https://mydocsurl.extension/{openapi-or-file-name}.json`)
+  - `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
 
   ## 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
   - 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`.
   - Email field on login for the Mintlify dashboard now autofocuses so you can start typing immediately _(quality of life improvement)_
   - Both custom domains and subdomains in Redis for a performance improvement on navigation load times (~50ms latency reduction)
   - 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
   - Improved error logging output—a quality of life upgrade for our engineering team when debugging
   - Minor fixes to the broken-link CI action when `contentDirectory` files are missing
   - Fixed a regression caused by the auth-protected preview fixes from last week where the active tab was not being set correctly in the navigation UI
   - Fixed theme light background color not being applied to active tab icons
   - Fixed an issue where changing the auth type in the dashboard would update and then flip back to the previously saved type—now the new selection persists after saving
   - Internal DX improvements for enterprise customers with custom UI libraries—it's now easier for us to include your components and accommodate requests on shorter timelines
 </Update>
 
 <Update label="July 27 - August 2" tags={["Improvements"]} rss={{ title: "Weekly Updates", description: "Authentication improvements, search enhancements, and assistant API" }}>
@@ -219,11 +219,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)
 
   ## API playground enhancements
 
   - Fixed `multipart/form-data` file upload functionality in the API playground
   - Fixed anchor link behavior so clicking them updates the URL without scrolling to top of page
   - Fixed anchor link issues in nested tabs
 
@@ -235,15 +235,15 @@
 
   ## Performance and reliability
 
   - Made search feel more crisp and accurate by aborting debounced requests as you type
   - Resource provisions for a new CDN - expect image asset and page load times to improve soon
   - Fixed bugs for rendering complex Mermaid diagrams like GANTT charts
   - Fixed CLI bugs on Windows to improve stability and added tests to prevent regression
 
   ## Technical improvements
 
   - Added OpenTelemetry for traces in NextJS application to improve time to first byte for customers
   - Migrated from Octokit to GitHub API Client to improve latency in the web editor experience
   - Fixed duplicate meta tags for OpenGraph
   - Upgraded MongoDB from version 6 to 7 for improved performance and new features
 </Update>
@@ -251,16 +251,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
   - 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).
 
   ## 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).
 
   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.
 
@@ -273,7 +273,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
   - 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
@@ -281,10 +281,10 @@
   Learn more in the [assistant docs](/guides/assistant).
 
   ## Subscribable changelogs
   - Automatically generate an RSS feed from changelog pages
   - Integrate RSS-enabled updates with Slack, email, and other tools
 
   Learn more in our new [Changelog guide](/guides/changelogs)
 
 </Update>
 
@@ -299,14 +299,14 @@
   Learn more at [API playground docs.](/api-playground/)
 
   ## `mint update`
   Can now use `mint update` to update your CLI.
 </Update>
 
 <Update label="April 2025" tags={["New releases", "Improvements"]}>
   ## Web Editor 3.0
 
   <Frame>
     ![Webeditor3 Jpe](/images/webeditor3.jpeg)
   </Frame>
   Overhauled usability in the WYSIWYG editor.
 
@@ -315,21 +315,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
   - 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
   - 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
 
   <Frame>
     ![AI Translations graphic](/images/changelog/translations.png)
@@ -364,10 +364,10 @@
 
   - OG images fixed
   - Fixed icon style inconsistency for anchors without container
   - Improved styling nits for dashboard border for mobile-tablet-desktop responsiveness
   - 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
 </Update>
 
 <Update label="February 2025" tags={["New releases", "Improvements"]}>
@@ -380,7 +380,7 @@
 
   Upgrade from `mint.json` to `docs.json` with the following steps:
 
   1. Make sure your CLI is the latest version
 
   ```bash
   npm i mint@latest -g
@@ -394,15 +394,15 @@
 
   1. Delete your old `mint.json` file and push your changes
 
   ## CI Checks
 
   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).
 
   ## .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.
 
   ## More Themes
 
   <Frame>
     ![graphic with text "Themes v2"](/images/changelog/themes.png)
@@ -419,27 +419,27 @@
 
   - [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.
 </Update>
 
 <Update label="January 2025" tags={["Improvements"]}>
   ## AI Assistant Improvements
 
   - New UI with dedicated chat page & pre-filled prompts
-  - Stability improvements, e.g. bug fixes of editing the wrong file or no files at all
+  - 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
 
   Customize access to any page or section of content depending on user permissions. Supports connecting with your own authentication system.
 
   ## Revamped API Playground
 
   We’ve overhauled the design and performance of the [API Playground](/api-playground/). Updates include:
 
   - Easier detail expansion for an overview of a field
-  - More intuitive nested design, e.g. adding or deleting items
+  - More intuitive nested design. For example, adding or deleting items
   - Faster response times
 
   ## Quality Improvements
@@ -457,27 +457,27 @@
 </Update>
 
 <Update label="November 2024">
   ## AI Writer
 
   <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
 
   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.
 
   ## Web Editor
 
   <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).
 
   ## /llms.txt support
 
   <Frame>
     ![llms.txt support](/images/changelog/llms.jpg)
@@ -486,23 +486,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.
 
   ### 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.
 </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.
 
   <Frame>
     ![Changelog](/images/changelog/changelog.jpg)
   </Frame>
   ## Code Line Highlighting
 
   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.
 
@@ -526,7 +526,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`:
 
   ```json
   "codeBlock": {
@@ -534,7 +534,7 @@
   }
   ```
 
   ## Advanced Footer
 
   <Frame>
     ![Advanced Footer](/images/changelog/advanced-footer.gif)
@@ -545,29 +545,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.
 
   ## Custom Prompts for AI Chat
 
   You can now customize the prompts for the AI chat. Please reach out to [support](mailto:support@mintlify.com) 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.
   - 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
 
   - 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.
   - We now use the Scalar OpenAPI parser to parse OpenAPI definitions which improves the performance, fixes parsing issues, and surfaces better error messages.
   - 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.
@@ -576,18 +576,18 @@
 </Update>
 
 <Update label="September 2024">
   ## Custom Fonts
 
   <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
 
   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
 
   <Frame>
     ![Performance Improvements](/images/changelog/performance-improvements.png)
@@ -596,10 +596,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
 
   <Frame>
     ![SEO Improvements](/images/changelog/seo-improvements.jpeg)
   </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.
 
@@ -607,75 +607,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.
   - Shipped GitLab connection UI.
   - Fix incorrect analytics data.
   - Add-on's can now be directly purchased through the dashboard.
 
   ## Bug Fixes
 
   - 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
     common issues to help you sort them out quickly —
     [Read the docs](/api-playground/troubleshooting)
 </Update>
 
 <Update label="August 2024">
   ## OpenAPI Reference Pages
 
   - Endpoints defined by OpenAPI that are complex and recursive are now 98%
     smaller.
   - We now show
     [additionalProperties](https://swagger.io/docs/specification/data-models/dictionaries/)
     in OpenAPI pages.
 
   ## File Uploads in API Playground
 
   By default, API playground requests are proxied by Mintlify. Now you can use
   `disableProxy` to disable this behavior and support request types like file
   uploads.
 
   - [Learn more about API configurations](settings#api-configurations)
 
   ## Mobile SEO improvements
 
   We've fixed the mobile layout of our docs so that they are more SEO-friendly -
   including adding proper aria tags to elements.
 
   ## Support Form
 
   We added a more detailed support form to the Mintlify dashboard. You can now
   submit a form to get in touch with us.
 
   ## Bug Fixes
 
   - Fixed a bug for the Segment integration functionality.
   - We now raise more granular error messages for GitHub permissions when
     interacting with the editor.
   - Fixed bugs where the navigation would not properly expand when a direct link
     was used.
 </Update>
 
 <Update label="July 2024">
   ## AI Widget
 
   <Frame>
     ![AI Widget](/images/changelog/widget.png)
   </Frame>
   For `Pro` users, we introduced Mintlify Widget, an extension of your docs to
   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
   on your existing documentation pages.
 
   - [Read the blog announcement](https://mintlify.com/blog/widget)
 
   ## Pro Plan
 
   We also updated our pricing plans for better customizability and scale.
 
   - [Read the blog announcement](https://mintlify.com/blog/pro-plan)
 
@@ -691,21 +691,21 @@
 </Update>
 
 <Update label="June 2024">
   ## Launch Week Highlights
 
   - 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.
   - Web Editor branching: create branches in our web editor without an IDE.
   - 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.
   - 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
 
   We now support sign-on via Okta SAML and OIDC.
 
   ## Mintlify REST API
 
   Programmatically rigger updates to your documentation.
 </Update>
@@ -720,13 +720,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).
 </Update>
 
 <Update label="March 2024">
   ## Mintlify MDX for VSCode
 
   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).
 </Update>
 
 <Update label="February 2024">
@@ -735,14 +735,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
 </Update>
 
 <Update label="January 2024">
   ## Launch Week Highlights
 
   - 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.
   - Snippets V2: We now support fully reusable components and variables for snippets.
   - Open-source MDX Engine: We've exposed two APIs—getCompiledMdx and MDXComponent—so you can access Mintlify markdown and code syntax highlighting. [Contributions to the project](https://github.com/mintlify/mdx) are welcome.
   - AI Chat Insights: Segment chat history by date and increase AI Chat quota from the dashboard, and see how often a specific query appears.
 </Update>

components/cards.mdx

@@ -54,7 +54,7 @@
 </Card>
 ```
 
 ### Link cards with custom CTAs
 
 You can customize the call-to-action text and control whether an arrow appears. By default, arrows only show for external links.
 
@@ -107,7 +107,7 @@
 <IconsOptional />
 
 <ResponseField name="color" type="string">
-  Icon color as a hex code (e.g., `#FF6B6B`).
+  Icon color as a hex code (for example, `#FF6B6B`).
 </ResponseField>
 
 <ResponseField name="href" type="string">

guides/auth0.mdx

@@ -4,26 +4,26 @@
 ---
 
 <Note>
   **Security Disclaimer**: While we provide this guide to help you integrate Auth0 with Mintlify, please consult with your security team before implementing any authentication solution. Mintlify is not responsible for any security issues that may arise from your specific implementation.
 </Note>
 
 ## Overview
 
 This guide walks you through setting up Auth0 as an authentication provider for your Mintlify documentation. By the end, your users will be able to log in to your documentation using their Auth0 credentials.
 
 <Steps>
   <Step title="Create a Regular Web Application in Auth0">
-    Log in to your Auth0 dashboard and navigate to **Applications** > **Applications**. Click the **Create Application** button, give your application a name (e.g., "Mintlify"), and select **Regular Web Applications** as the application type. Then click **Create**.
+    Log in to your Auth0 dashboard and navigate to **Applications** > **Applications**. Click the **Create Application** button, give your application a name (for example, "Mintlify"), and select **Regular Web Applications** as the application type. Then click **Create**.
 
     <Frame>![Creating a new application in Auth0](/images/guides/auth0/auth0-create-application.png)</Frame>
   </Step>
   <Step title="Get client information">
     After creating your application, you'll be taken to the application settings page. Here, you'll find the essential credentials needed for the OAuth integration:
 
     <Frame>![Auth0 client settings page](/images/guides/auth0/auth0clientsettings.png)</Frame>
 
     Make note of the following information:
-    - **Domain**: This is your Auth0 tenant domain (e.g., `your-tenant.auth0.com`)
+    - **Domain**: This is your Auth0 tenant domain (for example, `your-tenant.auth0.com`)
     - **Client ID**: The public identifier for your application
     - **Client Secret**: The secret key for your application (keep this secure)
 
@@ -45,7 +45,7 @@
     After filling in these details, click **Save changes** to store your OAuth configuration.
   </Step>
   <Step title="Configure Callback URL">
     Mintlify will generate a unique Redirect URL that Auth0 needs to recognize for the OAuth flow to work properly.
 
     Copy the Redirect URL from your Mintlify Dashboard's Authentication settings:
     <Frame>![Mintlify redirect URL](/images/guides/auth0/mintlifyredirecturl.png)</Frame>

image-embeds.mdx

@@ -6,7 +6,7 @@
 
 Add images, embed videos, and include interactive content with iframes to your documentation.
 
 All static assets in your docs repository are automatically served at the appropriate path on your domain. For example, if you have `/images/my-logo.png` in your repo, the image will be available at `https://docs.yoursite.com/images/my-logo.png`.
 
 <Frame>
 <img
@@ -29,12 +29,12 @@
 ```
 
 <Tip>
   Always include descriptive alt text to improve accessibility and SEO. The alt text should clearly describe what the image shows.
 </Tip>
 
-Image files must be less than 20MB. For larger files, host them on a CDN service like [Amazon S3](https://aws.amazon.com/s3) or [Cloudinary](https://cloudinary.com).
+Image files must be less than 20 MB. For larger files, host them on a CDN service like [Amazon S3](https://aws.amazon.com/s3) or [Cloudinary](https://cloudinary.com).
 
 ### HTML image embeds
 
 For more control over image display, use HTML `<img>` tags:
 
@@ -47,9 +47,9 @@
 />
 ```
 
 #### Disable zoom functionality
 
 To disable the default zoom on click for images, add the `noZoom` property:
 
 ```html highlight="4"
 <img 
@@ -76,7 +76,7 @@
 ```
 
 <Note>
   Images within anchor tags automatically display a pointer cursor to indicate they are clickable.
 </Note>
 
 #### Light and dark mode images
@@ -128,7 +128,7 @@
   src="https://www.youtube.com/embed/4KzFe50RQkQ"
   title="YouTube video player"
   frameBorder="0"
   allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
   allowFullScreen
 ></iframe>
 </Frame>
@@ -145,7 +145,7 @@
 ></video>
 ```
 
 ### Autoplay videos
 
 To autoplay a video, use:
 
@@ -164,7 +164,7 @@
   When using JSX syntax, write double-word attributes in camelCase: `autoPlay`, `playsInline`, `allowFullScreen`.
 </Note>
 
 ## iframes
 
 Embed external content using iframe elements:
 

installation.mdx

@@ -1,7 +1,7 @@
 ---
 title: "CLI installation"
 sidebarTitle: "Installation"
 description: "Install the CLI to preview and develop your docs locally"
 icon: "terminal"
 ---
 
@@ -14,10 +14,10 @@
   src="/images/installation/local-development-dark.png"
 />
 
 ## Installing the CLI
 
 <Info>
   **Prerequisite**: Please install [Node.js](https://nodejs.org/en) before proceeding.
 </Info>
 
 <Steps>
@@ -36,7 +36,7 @@
 
   </Step>
   <Step title="Preview locally.">
     Navigate to your docs directory (where your `docs.json` file is located) and execute the following command:
 
     ```bash
     mint dev
@@ -46,7 +46,7 @@
   </Step>
 </Steps>
 
 Alternatively, if you do not want to install the CLI globally, you can run a one-time script:
 
 ```bash
 npx mint dev
@@ -54,13 +54,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:
 
 ```bash
 mint update
 ```
 
 If this `mint update` command is not available on your local version, re-install the CLI with the latest version:
 
  <CodeGroup>
     ```bash npm
@@ -74,13 +74,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:
 
 ```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:
 
 ```mdx
 Port 3000 is already in use. Trying 3001 instead.
@@ -102,7 +102,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:
 
 ```bash
 mint broken-links
@@ -110,13 +110,13 @@
 
 ### Checking OpenAPI spec
 
 You can use the CLI to check your OpenAPI file for errors using the following command:
 
 ```bash
 mint openapi-check <openapiFilenameOrUrl>
 ```
 
-You can pass in a filename (e.g. `./openapi.yaml`) or a URL (e.g. `https://petstore3.swagger.io/api/v3/openapi.json`).
+You can pass in a filename (for example, `./openapi.yaml`) or a URL (for example, `https://petstore3.swagger.io/api/v3/openapi.json`).
 
 ### Renaming files
 
@@ -138,11 +138,11 @@
 
 ## Formatting
 
 While developing locally, we recommend using extensions in your IDE to recognize and format `MDX` files.
 
 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.
 
 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.
 
 ## Troubleshooting
 
@@ -155,7 +155,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.
   </Accordion>
   <Accordion title="Error: permission denied">
     This is due to not having the required permissions to globally install node packages.
@@ -163,12 +163,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.
 
    **Solution:** Run `mint update` to get the latest changes.
   </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.
 
     If you don't use npm or don't see it in the -g list, try `which mint` to locate the installation.