Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion advanced/dashboard/permissions.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Editor Permissions'
title: 'Editor permissions'
description: 'Allow more members of your team to update your docs'
---

Expand Down
2 changes: 1 addition & 1 deletion advanced/dashboard/sso.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Single Sign-On (SSO)"
title: "Single sign-on (SSO)"
description: "Customize how your team can login to your admin dashboard"
---

Expand All @@ -7,9 +7,9 @@
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:[email protected]).

Check warning on line 10 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L10

Did you really mean 'Okta'?

Check warning on line 10 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L10

Did you really mean 'Entra'?

## Okta

Check warning on line 12 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L12

Did you really mean 'Okta'?

<Tabs>
<Tab title="SAML">
Expand Down Expand Up @@ -45,7 +45,7 @@
</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.

Check warning on line 48 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L48

Did you really mean 'Okta'?
</Step>
</Steps>
</Tab>
Expand Down Expand Up @@ -91,7 +91,7 @@
</Tab>
</Tabs>

## Microsoft Entra

Check warning on line 94 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L94

Did you really mean 'Entra'?

<Tabs>
<Tab title="SAML">
Expand Down
2 changes: 1 addition & 1 deletion ai-ingestion.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "AI Ingestion"
title: "AI ingestion"
description: "Prepare your documentation for LLMs and AI tools"

Check warning on line 3 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L3

Did you really mean 'LLMs'?
icon: "bot-message-square"
---

Expand All @@ -12,7 +12,7 @@
)
}

Mintlify generates optimized formats and provides shortcuts that help users get faster, more accurate responses when using your documentation as context for LLMs and AI tools.

Check warning on line 15 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L15

Did you really mean 'LLMs'?

## Contextual menu

Expand Down Expand Up @@ -40,8 +40,8 @@
"options": [
"copy",
"view",
"chatgpt",

Check warning on line 43 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L43

Did you really mean 'chatgpt'?
"claude"

Check warning on line 44 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L44

Did you really mean 'claude'?
]
}
}
Expand All @@ -49,7 +49,7 @@

## /llms.txt

The [/llms.txt file](https://llmstxt.org) is an industry standard that helps general-purpose LLMs index more efficiently, similar to how a sitemap helps search engines.

Check warning on line 52 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L52

Did you really mean 'LLMs'?

Every documentation site automatically hosts an `/llms.txt` file at the root that lists all available pages in your documentation. AI tools can use this file to understand your documentation structure and find relevant content to user prompts.

Expand All @@ -75,4 +75,4 @@

### Command \+ C shortcut

Select Command \+ C (Ctrl \+ C on Windows) to copy any page as Markdown.

Check warning on line 78 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L78

Did you really mean 'Ctrl'?
2 changes: 1 addition & 1 deletion api-playground/asyncapi/setup.mdx
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
title: "AsyncAPI Setup"
title: "AsyncAPI setup"
description: "Create websocket reference pages with AsyncAPI"
---

## Add an AsyncAPI specification file

To begin to create pages for your websockets, make sure you have a valid AsyncAPI schema document in either JSON or YAML format that follows the [AsyncAPI specification](https://www.asyncapi.com/docs/reference/specification/v3.0.0). Your schema must follow the AsyncAPI specification 3.0+.

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-playground/asyncapi/setup.mdx#L8

Did you really mean 'websockets'?

<Tip>
To make sure your AsyncAPI schema is valid, you can paste it into the
[AsyncAPI Studio](https://studio.asyncapi.com/)
</Tip>

## Auto-populate websockets pages

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-playground/asyncapi/setup.mdx#L15

Did you really mean 'websockets'?

You can add an `asyncapi` field to any tab or group in the navigation of your `docs.json`. This field can contain either the path to an AsyncAPI schema document in your docs repo, the URL of a hosted AsyncAPI schema document, or an array of links to AsyncAPI schema documents. Mintlify will automatically generate a page for each AsyncAPI websocket channel.

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

## Channel page

If you want more control over how you order your channels or if you want to just reference a single channel, you can create an MDX file with the `asyncapi` field in the frontmatter.

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-playground/asyncapi/setup.mdx#L76

Did you really mean 'frontmatter'?

```mdx
---
Expand Down
2 changes: 1 addition & 1 deletion api-playground/mdx/configuration.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'MDX Setup'
title: 'MDX setup'
description: 'Generate docs pages for your API endpoints using `MDX`'
---

Expand Down Expand Up @@ -160,7 +160,7 @@
```mdx Page Metadata
---
title: "Your page title"
authMethod: "none"

Check warning on line 163 in api-playground/mdx/configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-playground/mdx/configuration.mdx#L163

Did you really mean 'authMethod'?
---
```
</CodeGroup>
2 changes: 1 addition & 1 deletion api-playground/openapi-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "OpenAPI Setup"
title: "OpenAPI setup"
description: "Reference OpenAPI endpoints in your docs pages"
icon: "file-json"
---
Expand All @@ -25,7 +25,7 @@

### Specifying the URL for your API

To enable Mintlify features like the API playground, add a `servers` field to your OpenAPI document with your API's base URL.

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-playground/openapi-setup.mdx#L28

Did you really mean 'API's'?

```json
{
Expand Down Expand Up @@ -192,10 +192,10 @@

### Autogenerate `MDX` files

Use our Mintlify [scraper](https://www.npmjs.com/package/@mintlify/scraping) to autogenerate `MDX` pages for large OpenAPI documents.

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-playground/openapi-setup.mdx#L195

Did you really mean 'autogenerate'?

<Note>
Your OpenAPI document must be valid or the files will not autogenerate.

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-playground/openapi-setup.mdx#L198

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

The scraper generates:
Expand All @@ -207,12 +207,12 @@
<Steps>
<Step title="Generate `MDX` files.">
```bash
npx @mintlify/scraping@latest openapi-file <path-to-openapi-file>

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-playground/openapi-setup.mdx#L210

Did you really mean 'npx'?
```
</Step>
<Step title="Specify an output folder.">
```bash
npx @mintlify/scraping@latest openapi-file <path-to-openapi-file> -o api-reference

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

api-playground/openapi-setup.mdx#L215

Did you really mean 'npx'?
```

Add the `-o` flag to specify a folder to populate the files into. If a folder is not specified, the files will populate in the working directory.
Expand Down
2 changes: 1 addition & 1 deletion authentication-personalization/authentication-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Authentication Setup"
title: "Authentication setup"
description: "Guarantee privacy of your docs by authenticating users"
icon: "file-lock"
---
Expand All @@ -19,7 +19,7 @@
<Tab title="JWT">
### Prerequisites

* An authentication system that can generate and sign JWTs.

Check warning on line 22 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L22

Did you really mean 'JWTs'?
* A backend service that can create redirect URLs.

### Implementation
Expand Down Expand Up @@ -54,20 +54,20 @@

<CodeGroup>
```ts TypeScript
import * as jose from 'jose';

Check warning on line 57 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L57

Did you really mean 'jose'?
import { Request, Response } from 'express';

const TWO_WEEKS_IN_MS = 1000 * 60 * 60 * 24 * 7 * 2;

const signingKey = await jose.importPKCS8(process.env.MINTLIFY_PRIVATE_KEY, 'EdDSA');

Check warning on line 62 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L62

Did you really mean 'signingKey'?

export async function handleRequest(req: Request, res: Response) {
const user = {
expiresAt: Math.floor((Date.now() + TWO_WEEKS_IN_MS) / 1000), // 2 week session expiration

Check warning on line 66 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L66

Did you really mean 'expiresAt'?
groups: res.locals.user.groups,
content: {
firstName: res.locals.user.firstName,

Check warning on line 69 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L69

Did you really mean 'firstName'?
lastName: res.locals.user.lastName,

Check warning on line 70 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L70

Did you really mean 'lastName'?
},
};

Expand Down Expand Up @@ -168,8 +168,8 @@
```json
{
"content": {
"firstName": "Jane",

Check warning on line 171 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L171

Did you really mean 'firstName'?
"lastName": "Doe"

Check warning on line 172 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L172

Did you really mean 'lastName'?
},
"groups": ["engineering", "admin"]
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Partial Authentication Setup"
title: "Partial authentication setup"
description: "Control access to specific pages"
icon: "file-lock-2"
---
Expand All @@ -14,7 +14,7 @@

## Making pages public

By default, all pages are protected. Add the `public` property to the page's frontmatter to make it viewable without authentication:

Check warning on line 17 in authentication-personalization/partial-authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/partial-authentication-setup.mdx#L17

Did you really mean 'frontmatter'?

```mdx
---
Expand Down
2 changes: 1 addition & 1 deletion authentication-personalization/personalization-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Personalization Setup"
title: "Personalization setup"
description: "Let users log in for customized documentation experiences"
icon: "user-cog"
---
Expand All @@ -16,7 +16,7 @@
<Tab title="JWT">
### Prerequisites

* A login system that can generate and sign JWTs.

Check warning on line 19 in authentication-personalization/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/personalization-setup.mdx#L19

Did you really mean 'JWTs'?
* A backend service that can create redirect URLs.

### Implementation
Expand Down Expand Up @@ -124,8 +124,8 @@
```json
{
"content": {
"firstName": "Jane",

Check warning on line 127 in authentication-personalization/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/personalization-setup.mdx#L127

Did you really mean 'firstName'?
"lastName": "Doe"

Check warning on line 128 in authentication-personalization/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/personalization-setup.mdx#L128

Did you really mean 'lastName'?
},
"groups": ["engineering", "admin"]
}
Expand Down Expand Up @@ -159,8 +159,8 @@
* Uses your existing session authentication to identify users
* Returns user data in the `User` format (see [Sending Data](/authentication-personalization/sending-data))
* If the API domain and the docs domain **do not exactly match**:
* Add the docs domain to your API's `Access-Control-Allow-Origin` header (must not be `*`).

Check warning on line 162 in authentication-personalization/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/personalization-setup.mdx#L162

Did you really mean 'API's'?
* Set your API's `Access-Control-Allow-Credentials` header to `true`.

Check warning on line 163 in authentication-personalization/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/personalization-setup.mdx#L163

Did you really mean 'API's'?

<Warning>
Only enable CORS headers on this specific endpoint, not your entire dashboard API.
Expand Down
2 changes: 1 addition & 1 deletion authentication-personalization/sending-data.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Sending Data"
title: "Sending data"
description: "User data format for personalizing your documentation"
icon: "send"
---
Expand All @@ -26,8 +26,8 @@
path="expiresAt"
type="number"
>
Session expiration time in **seconds since epoch**. If the user loads a page after this time, their stored data is automatically deleted and they must reauthenticate.

Check warning on line 29 in authentication-personalization/sending-data.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/sending-data.mdx#L29

Did you really mean 'reauthenticate'?
<Warning><b>For JWT handshakes:</b> This differs from the JWT's `exp` claim, which determines when a JWT is considered invalid. Set the JWT `exp` claim to a short duration (10 seconds or less) for security. Use `expiresAt` for the actual session length (hours to weeks).</Warning>

Check warning on line 30 in authentication-personalization/sending-data.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/sending-data.mdx#L30

Did you really mean 'expiresAt'?
</ParamField>
<ParamField
path="groups"
Expand All @@ -52,13 +52,13 @@
```mdx
Welcome back, {user.firstName}! Your {user.plan} plan includes...
```
With the example `user` data, this would render as: Welcome back, Ronan! Your Enterprise plan includes...

Check warning on line 55 in authentication-personalization/sending-data.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/sending-data.mdx#L55

Did you really mean 'Ronan'?
</ParamField>
<ParamField
path="apiPlaygroundInputs"
type="object"
>
User-specific values that will be prefilled in the API playground if supplied. Save users time when testing your APIs with their own data.

Check warning on line 61 in authentication-personalization/sending-data.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/sending-data.mdx#L61

Did you really mean 'prefilled'?

**Example**:
```json
Expand All @@ -68,7 +68,7 @@
"query": { "org_id": "12345" }
}
```
If a user makes requests at a specific subdomain, you can send `{ server: { subdomain: 'foo' } }` as an `apiPlaygroundInputs` field. This value will be prefilled on any API page with the `subdomain` value.

Check warning on line 71 in authentication-personalization/sending-data.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/sending-data.mdx#L71

Did you really mean 'prefilled'?

<Note>The `header`, `query`, and `cookie` fields will only prefill if they are part of your [OpenAPI security scheme](https://swagger.io/docs/specification/authentication/). If a field is in either the `Authorization` or `Server` sections, it will prefill. Creating a standard header parameter named `Authorization` will not enable this feature.</Note>
</ParamField>
Expand All @@ -77,11 +77,11 @@

```json
{
"expiresAt": 1735689600,

Check warning on line 80 in authentication-personalization/sending-data.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/sending-data.mdx#L80

Did you really mean 'expiresAt'?
"groups": ["admin", "beta-users"],
"content": {
"firstName": "Jane",

Check warning on line 83 in authentication-personalization/sending-data.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/sending-data.mdx#L83

Did you really mean 'firstName'?
"lastName": "Smith",

Check warning on line 84 in authentication-personalization/sending-data.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/sending-data.mdx#L84

Did you really mean 'lastName'?
"company": "TechCorp",
"plan": "Enterprise",
"region": "us-west"
Expand All @@ -89,7 +89,7 @@
"apiPlaygroundInputs": {
"header": {
"Authorization": "Bearer abc123",
"X-Org-ID": "techcorp"

Check warning on line 92 in authentication-personalization/sending-data.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/sending-data.mdx#L92

Did you really mean 'techcorp'?
},
"server": {
"environment": "production",
Expand Down
2 changes: 1 addition & 1 deletion changelog.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Product Updates"
title: "Product updates"
description: "New updates and improvements"
mode: "center"
---
Expand Down Expand Up @@ -83,7 +83,7 @@
- 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

Check warning on line 86 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L86

Did you really mean 'Codeblocks'?

Check warning on line 86 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L86

Did you really mean 'callouts'?

Check warning on line 86 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L86

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

<Update label="February 2025">
Expand Down Expand Up @@ -114,9 +114,9 @@

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

Check warning on line 117 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L117

Did you really mean 'LLMs'?

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

Check warning on line 119 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L119

Did you really mean 'LLMs'?

## More Themes

Expand Down Expand Up @@ -198,7 +198,7 @@
<Frame>
![llms.txt support](/images/changelog/llms.jpg)
</Frame>
All docs instances are now automatically hosted at /llms.txt and /llms-full.txt so that LLMs can easily ingest your documentation. For more information, read the [docs on the new llms.txt standard.](https://llmstxt.org)

Check warning on line 201 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L201

Did you really mean 'LLMs'?

## Localization

Expand Down Expand Up @@ -270,7 +270,7 @@
## 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 273 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L273

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.
Expand All @@ -284,7 +284,7 @@
- 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.

Check warning on line 287 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L287

Did you really mean 'autogenerated'?
- Add in-line-style support for icons
- Fixed the pop-in of custom CSS in docs.
- Properly show in-line code styling in conjunction with links.
Expand Down Expand Up @@ -317,7 +317,7 @@
<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.

Check warning on line 320 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L320

Did you really mean 'navbar'?

## Dashboard Improvements

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

## File Uploads in API Playground

By default, API playground requests are proxied by Mintlify. Now you can use

Check warning on line 354 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L354

Did you really mean 'proxied'?
`disableProxy` to disable this behavior and support request types like file
uploads.

Expand Down Expand Up @@ -384,7 +384,7 @@
</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

Check warning on line 387 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L387

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

- [Read the blog announcement](https://mintlify.com/blog/widget)
Expand Down Expand Up @@ -419,7 +419,7 @@
<Update label="May 2024">
## Okta SSO

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

Check warning on line 422 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L422

Did you really mean 'Okta'?

## Mintlify REST API

Expand All @@ -442,7 +442,7 @@
<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).

Check warning on line 445 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L445

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

<Update label="February 2024">
Expand All @@ -451,7 +451,7 @@
- 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 454 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L454

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

<Update label="January 2024">
Expand Down
2 changes: 1 addition & 1 deletion components/code-groups.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Code Groups"
title: "Code groups"
description: "The CodeGroup component lets you combine code blocks in a display separated by tabs"
icon: "group"
---
Expand Down
2 changes: 1 addition & 1 deletion components/responses.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Response Fields'
title: 'Response fields'
description: 'Display API response values'
---

Expand Down
2 changes: 1 addition & 1 deletion contact-support.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Contact Support"
title: "Contact support"
icon: "circle-help"
description: "We're here to help you get the most out of Mintlify"
---
Expand Down
2 changes: 1 addition & 1 deletion editor.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Web Editor"
title: "Web editor"
description: "Build your documentation using the Mintlify web editor"
icon: "mouse-pointer-2"
---
Expand Down
2 changes: 1 addition & 1 deletion guides/assistant.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "AI Assistant"
title: "AI assistant"
description: "Help users succeed with your product and find answers faster"
icon: "bot"
---
Expand All @@ -12,7 +12,7 @@

The assistant answers questions about your documentation through natural language queries. When users ask a question, the assistant searches your content, cites relevant sources, and provides contextual answers sourced from your documentation.

The assistant uses agentic RAG (retrieval-augmented generation) with tool calling and runs on Claude Sonnet 4 by default.

Check warning on line 15 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/assistant.mdx#L15

Did you really mean 'agentic'?

You can monitor user interactions and export query data from your dashboard to gain insights into user needs and identify content gaps.

Expand All @@ -22,7 +22,7 @@

Users can access the assistant in two ways:

- **Keyboard shortcut**: <kbd>Command</kbd> + <kbd>I</kbd> (<kbd>Ctrl</kbd> + <kbd>I</kbd> on Windows)

Check warning on line 25 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/assistant.mdx#L25

Did you really mean 'Ctrl'?
- **Assistant button** next to the search bar
<img
src="/images/assistant/assistant-button-light.png"
Expand All @@ -45,7 +45,7 @@

Both methods open a chat panel on the right side of your docs. Users can ask any question and the assistant will search your documentation for an answer. If no relevant information is found, the assistant will respond that it cannot answer the question.

## Making content AI ingestible

Check warning on line 48 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/assistant.mdx#L48

Did you really mean 'ingestible'?

Structure your documentation to help the assistant provide accurate, relevant answers. Clear organization and comprehensive context benefit both human readers and AI understanding.

Expand All @@ -54,7 +54,7 @@
- Write descriptive headings for sections.
- Create a logical information hierarchy.
- Use consistent formatting across your docs.
- Include comprehensive metadata in page frontmatter.

Check warning on line 57 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/assistant.mdx#L57

Did you really mean 'frontmatter'?
- Break up long blocks of text into shorter paragraphs.
</Card>

Expand Down
2 changes: 1 addition & 1 deletion guides/auth0.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Using Auth0 with the OAuth Handshake"
title: "Using Auth0 with the OAuth handshake"
description: "If Auth0 is the source of truth for your user data, you can set up Mintlify as an OAuth client app to authenticate your users."
---

Expand Down
2 changes: 1 addition & 1 deletion image-embeds.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Images and Embeds'
title: 'Images and embeds'
description: 'Add image, video, and other HTML elements'
icon: 'image'
---
Expand Down Expand Up @@ -131,7 +131,7 @@

<Warning>
Since Mintlify needs to adhere to the JSX syntax, double word attributes will need to
be written in camelCase such as `autoPlay` and `playsInline`.

Check warning on line 134 in image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

image-embeds.mdx#L134

Did you really mean 'camelCase'?
</Warning>

## iFrames
Expand Down
2 changes: 1 addition & 1 deletion integrations/analytics/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Analytics Integrations"
title: "Analytics integrations"
description: "Integrate with an analytics platform to track events"
---

Expand Down
2 changes: 1 addition & 1 deletion integrations/privacy/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Privacy Integrations"
title: "Privacy integrations"
description: "Integrate with a data privacy platform"
---

Expand Down
2 changes: 1 addition & 1 deletion integrations/support/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Support Integrations"
title: "Support integrations"
description: "Integrate with a support widget"
---

Expand Down
2 changes: 1 addition & 1 deletion list-table.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Lists and Tables"
title: "Lists and tables"
description: "Display information in lists and tables"
icon: "list"
---
Expand Down
2 changes: 1 addition & 1 deletion reusable-snippets.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Reusable Snippets'
title: 'Reusable snippets'
description: 'Reusable, custom snippets to keep content in sync'
icon: 'recycle'
---
Expand Down
2 changes: 1 addition & 1 deletion settings.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Global Settings"
title: "Global settings"
description: "Configure site-wide settings with the `docs.json` file"
icon: "settings-2"
keywords: ["docs.json", "settings", "customization", "configuration"]
Expand All @@ -13,7 +13,7 @@

To get started, you only need to specify `theme`, `name`, `colors.primary`, and `navigation`. Other fields are optional and you can add them as your documentation needs grow.

For the best editing experience, include the schema reference at the top of your `docs.json` file. This enables autocomplete, validation, and helpful tooltips in most code editors:

Check warning on line 16 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L16

Did you really mean 'tooltips'?

```json
{
Expand Down Expand Up @@ -143,7 +143,7 @@

<Expandable title="Fonts">
<ResponseField name="family" type="string" required>
Font family, such as "Open Sans", "Playfair Display".

Check warning on line 146 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L146

Did you really mean 'Playfair'?
</ResponseField>
<ResponseField name="weight" type="number">
Font weight, such as 400 or 700. Variable fonts support precise weights such as 550.
Expand Down Expand Up @@ -248,12 +248,12 @@

### Structure

<ResponseField name="navbar" type="object">

Check warning on line 251 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L251

Did you really mean 'navbar'?
Navigation bar items.

<Expandable title="Navbar">
<ResponseField name="links" type="array of object">
Links to display in the navbar

Check warning on line 256 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L256

Did you really mean 'navbar'?

<Expandable title="Links">
<ResponseField name="label" type="string" required>
Expand Down Expand Up @@ -291,14 +291,14 @@

<Expandable title="Navigation">
<ResponseField name="global" type="object">
Global navigation elements that appear accross all pages and sections.

Check warning on line 294 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L294

Did you really mean 'accross'?

<Expandable title="Global">
<ResponseField name="languages" type="array of object">
Language switcher configuration for multi-language sites.

<Expandable title="Languages">
<ResponseField name="language" type="&quot;en&quot; | &quot;cn&quot; | &quot;zh&quot; | &quot;zh-Hans&quot; | &quot;zh-Hant&quot; | &quot;es&quot; | &quot;fr&quot; | &quot;ja&quot; | &quot;jp&quot; | &quot;pt&quot; | &quot;pt-BR&quot; | &quot;de&quot; | &quot;ko&quot; | &quot;it&quot; | &quot;ru&quot; | &quot;id&quot; | &quot;ar&quot; | &quot;tr&quot;" required>

Check warning on line 301 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L301

Did you really mean 'ko'?
Language code in ISO 639-1 format
</ResponseField>
<ResponseField name="default" type="boolean">
Expand Down Expand Up @@ -525,7 +525,7 @@
Contextual menu for AI-optimized content and integrations.

<Expandable title="Contextual">
<ResponseField name="options" type="array of &quot;copy&quot; | &quot;view&quot; | &quot;chatgpt&quot; | &quot;claude&quot;" required>

Check warning on line 528 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L528

Did you really mean 'chatgpt'?

Check warning on line 528 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L528

Did you really mean 'claude'?
Actions available in the contextual menu. The first option appears as the default.
- `copy`: Copy the current page as Markdown to the clipboard.
- `view`: View the current page as Markdown in a new tab.
Expand All @@ -543,7 +543,7 @@

### API Configurations

<ResponseField name="api" type="object">

Check warning on line 546 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L546

Did you really mean 'api'?
API documentation and interactive playground settings.

<Expandable title="Api">
Expand Down Expand Up @@ -962,7 +962,7 @@
"footer": {
"socials": {
"x": "https://x.com/example",
"linkedin": "https://www.linkedin.com/company/example",

Check warning on line 965 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L965

Did you really mean 'linkedin'?
"github": "https://github.com/example",
"slack": "https://example.com/community"
},
Expand Down Expand Up @@ -1005,7 +1005,7 @@
},
"integrations": {
"ga4": {
"measurementId": "G-XXXXXXXXXX"

Check warning on line 1008 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1008

Did you really mean 'measurementId'?
},
"koala": {
"publicApiKey": "pk_example_key_123"
Expand All @@ -1014,8 +1014,8 @@
"enabled": true
},
"cookies": {
"key": "example_cookie_key",

Check warning on line 1017 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1017

Did you really mean 'example_cookie_key'?
"value": "example_cookie_value"

Check warning on line 1018 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1018

Did you really mean 'example_cookie_value'?
}
},
"contextual": {
Expand Down Expand Up @@ -1136,7 +1136,7 @@
"footer": {
"socials": {
"x": "https://x.com/example",
"linkedin": "https://www.linkedin.com/company/example",

Check warning on line 1139 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1139

Did you really mean 'linkedin'?
"github": "https://github.com/example",
"slack": "https://example.com/community"
},
Expand Down Expand Up @@ -1179,7 +1179,7 @@
},
"integrations": {
"ga4": {
"measurementId": "G-XXXXXXXXXX"

Check warning on line 1182 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1182

Did you really mean 'measurementId'?
},
"koala": {
"publicApiKey": "pk_example_key_123"
Expand All @@ -1188,8 +1188,8 @@
"enabled": true
},
"cookies": {
"key": "example_cookie_key",

Check warning on line 1191 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1191

Did you really mean 'example_cookie_key'?
"value": "example_cookie_value"

Check warning on line 1192 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1192

Did you really mean 'example_cookie_value'?
}
},
"contextual": {
Expand Down Expand Up @@ -1304,7 +1304,7 @@
"footer": {
"socials": {
"x": "https://x.com/example",
"linkedin": "https://www.linkedin.com/company/example",

Check warning on line 1307 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1307

Did you really mean 'linkedin'?
"github": "https://github.com/example",
"slack": "https://example.com/community"
},
Expand Down Expand Up @@ -1347,7 +1347,7 @@
},
"integrations": {
"ga4": {
"measurementId": "G-XXXXXXXXXX"

Check warning on line 1350 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1350

Did you really mean 'measurementId'?
},
"koala": {
"publicApiKey": "pk_example_key_123"
Expand All @@ -1356,8 +1356,8 @@
"enabled": true
},
"cookies": {
"key": "example_cookie_key",

Check warning on line 1359 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1359

Did you really mean 'example_cookie_key'?
"value": "example_cookie_value"

Check warning on line 1360 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1360

Did you really mean 'example_cookie_value'?
}
},
"contextual": {
Expand Down
2 changes: 1 addition & 1 deletion settings/broken-links.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Redirects and Broken Links"
title: "Redirects and broken links"
description: "Tools to help prevent invalid links"
icon: 'link-2'
---
Expand Down
2 changes: 1 addition & 1 deletion settings/ci.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "CI Checks"
title: "CI checks"
description: "Add checks for broken links, linting, and grammar to the updating process"
icon: "circle-check"
---
Expand Down
2 changes: 1 addition & 1 deletion settings/custom-domain.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Custom Domain"
title: "Custom domain"
description: "Host your documentation at your website's custom domain"
icon: "globe"
---
Expand Down Expand Up @@ -31,9 +31,9 @@
/>
</Frame>

## Verification with Vercel

Check warning on line 34 in settings/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/custom-domain.mdx#L34

Did you really mean 'Vercel'?

If Vercel happens to be your domain provider, you will have to add a verification `TXT` record. This information will show on your dashboard after submitting your custom domain, as well as be emailed to you.

Check warning on line 36 in settings/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/custom-domain.mdx#L36

Did you really mean 'Vercel'?

## Configuring your DNS

Expand Down
2 changes: 1 addition & 1 deletion settings/custom-scripts.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Custom Scripts'
title: 'Custom scripts'
description: 'Fully customize your documentation with custom CSS and JS'
icon: "code"
---
Expand All @@ -12,7 +12,7 @@

### Adding `style.css`

For example, you can add the following `style.css` file to customize the styling of the navbar and footer.

Check warning on line 15 in settings/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/custom-scripts.mdx#L15

Did you really mean 'navbar'?

```css
#navbar {
Expand Down Expand Up @@ -50,7 +50,7 @@
- Header: `header`
- NavBarTransition: `navbar-transition`
- NavigationItems: `navigation-items`
- Navbar: `navbar`

Check warning on line 53 in settings/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/custom-scripts.mdx#L53

Did you really mean 'Navbar'?
- PageContextMenu: `page-context-menu`
- PageContextMenuButton: `page-context-menu-button`
- PageTitle: `page-title`
Expand All @@ -76,11 +76,11 @@
- AlmondNavBottomSectionDivider: `almond-nav-bottom-section-divider`
- Anchor: `nav-anchor`
- Anchors: `nav-anchors`
- APISection: `api-section`

Check warning on line 79 in settings/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/custom-scripts.mdx#L79

Did you really mean 'APISection'?
- APISectionHeading: `api-section-heading`
- APISectionHeadingSubtitle: `api-section-heading-subtitle`
- APISectionHeadingTitle: `api-section-heading-title`
- Callout: `callout`

Check warning on line 83 in settings/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/custom-scripts.mdx#L83

Did you really mean 'Callout'?
- Card: `card`
- CardGroup: `card-group`
- ChatAssistantSheet: `chat-assistant-sheet`
Expand Down Expand Up @@ -130,7 +130,7 @@
- TabsBarItem: `nav-tabs-item`
- TableOfContents: `toc`
- TableOfContentsItem: `toc-item`
- Tooltip: `tooltip`

Check warning on line 133 in settings/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/custom-scripts.mdx#L133

Did you really mean 'Tooltip'?
- TopbarRightContainer: `topbar-right-container`
- TryitButton: `tryit-button`
- Update: `update`
Expand Down
2 changes: 1 addition & 1 deletion settings/preview-deployments.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Preview Deployments"
title: "Preview deployments"
description: "Preview changes to your docs in a live deployment"
icon: "scan-eye"
---
Expand Down
2 changes: 1 addition & 1 deletion text.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Headers and Text"
title: "Headers and text"
description: "Text, title, and styling in standard markdown"
icon: 'heading'
---
Expand Down Expand Up @@ -91,7 +91,7 @@

### Line Breaks

Markdown syntax also recognizes a double enter in your MDX as a linebreak.

Check warning on line 94 in text.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

text.mdx#L94

Did you really mean 'linebreak'?

```html
<br />
Expand Down