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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ IgnoredScopes = code, tt, img, url, a
SkippedScopes = script, style, pre, figure, code

Packages = Google

Vocab = Mintlify

# This is required since Vale doesn't officially support MDX
Expand All @@ -23,9 +22,16 @@ Vale.Avoid = NO # Too aggressive about common technical terms
TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>), \
(<[^>]*>)
(<[^>]*>), \
\{[^}]*\}, \
(`[^`]*`), \
(```[\s\S]*?```)

BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})
(?sm)^({.+.*})$, \
(?sm)^```[\s\S]*?```$

CommentDelimiters = {/*, */}

CommentDelimiters = {/*, */}
[changelog.mdx]
BasedOnStyles =
19 changes: 15 additions & 4 deletions .vale/styles/config/vocabularies/Mintlify/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@
# =============================================================================
# MINTLIFY-SPECIFIC TERMS
# =============================================================================
APISection
autoplay
bearerAuth
borderRadius
camelCase
discoverability
(?i)callouts?
CTAs
drilldown
expandables
favicon
Expand All @@ -17,9 +19,11 @@ isHidden
(?i)modetoggle
myName
myObject
navbar
onboarding
(?i)openapi
repo
Ronan
topbar
(?i)tooltips?
url
Expand All @@ -40,6 +44,7 @@ CircleCI
Clearbit
Ctrl
Cypress
Docusaurus
Django
DynamoDB
Elasticsearch
Expand Down Expand Up @@ -76,6 +81,7 @@ Mocha
MongoDB
MySQL
Next.js
nginx
Node.js
NodeJS
npx
Expand Down Expand Up @@ -115,6 +121,7 @@ Webflow
WebKit
(?i)webpack
WebStorm
Windsurf's
Zapier

# =============================================================================
Expand All @@ -123,21 +130,22 @@ Zapier
agentic
allowlist
APIs
API's
args
async
autogenerated
autogenerating
autogenerat(e|ed|ing)?
await
bool
boolean
Blockquote
Blockquotes
cdn
cli
CNAME
cpu
config
const
cors
CNAME
csrf
css
ctx
Expand Down Expand Up @@ -171,6 +179,7 @@ lang
len
localhost
md
(?i)Memoize
middleware
Multiline
mvc
Expand All @@ -186,6 +195,7 @@ orm
params
pnpm
png
prefill(ing|ed)?
prepend
prepended
prev
Expand Down Expand Up @@ -234,8 +244,9 @@ ux
val
var
vars
waypoints
webhook
websocket
websockets?
xhr
xhr2
yaml
Expand Down
2 changes: 1 addition & 1 deletion analytics/feedback.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,13 @@
Best practices for setting feedback statuses:

* **Pending**: Feedback is awaiting review.
* **In Progress**: Feedback has been validated and is being worked on.

Check warning on line 57 in analytics/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

analytics/feedback.mdx#L57

In general, use active voice instead of passive voice ('been validated').

Check warning on line 57 in analytics/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

analytics/feedback.mdx#L57

In general, use active voice instead of passive voice ('being worked').
* **Resolved**: Feedback has been resolved.

Check warning on line 58 in analytics/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

analytics/feedback.mdx#L58

In general, use active voice instead of passive voice ('been resolved').
* **Dismissed**: Feedback has been dismissed as not actionable, irrelevant, or inaccurate.

Check warning on line 59 in analytics/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

analytics/feedback.mdx#L59

In general, use active voice instead of passive voice ('been dismissed').

### Filtering by status

Use the status filter to control which feedback is displayed. Uncheck a status to hide all feedback with that status. By default, all feedback is displayed.
Use the status filter to control which feedback is displayed. Clear a status to hide all feedback with that status. By default, all feedback is displayed.

Check warning on line 63 in analytics/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

analytics/feedback.mdx#L63

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

Check warning on line 63 in analytics/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

analytics/feedback.mdx#L63

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

### Adding internal notes

Expand Down
1 change: 0 additions & 1 deletion authentication-personalization/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@

**Choose partial authentication when:**
- Offering public getting-started guides with private advanced features
- Running a freemium product where premium users get additional documentation
- Publishing open-source docs with private enterprise sections

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L30

Use 'open source' instead of 'open-source'.

**Choose personalization when:**
- Creating public API documentation that shows user-specific examples
Expand All @@ -41,7 +40,7 @@

| Method | Available for | Setup complexity | Best for |
|:-------|:--------------|:-----------------|:----------|
| **JWT** | All approaches | Medium | Custom login flows, maximum security control |

Check warning on line 43 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L43

Spell out 'JWT', if it's unfamiliar to the audience.
| **OAuth 2.0** | All approaches | High | Third-party auth providers, enterprise security |
| **Mintlify Dashboard** | Authentication only | Low | Teams already using Mintlify dashboard |
| **Password** | Authentication only | Low | Simple shared access without personalization |
Expand All @@ -49,15 +48,15 @@

### When to use each method

**JWT**: Use when you have an existing authentication system and want full control over the login flow. Ideal for custom user management or when you need to decouple documentation access from your main application.

Check warning on line 51 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L51

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

Check warning on line 51 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L51

': U' should be in lowercase.

Check warning on line 51 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L51

Use 'app' instead of 'application'.

**OAuth 2.0**: Use when you want to leverage third-party authentication providers (Google, GitHub, etc.) or need enterprise-grade security standards. Best for organizations already using OAuth infrastructure.

Check warning on line 53 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L53

': U' should be in lowercase.

**Mintlify Dashboard**: Use when your documentation editors are also your documentation readers. Perfect for internal teams who already manage content through the Mintlify dashboard.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L55

': U' should be in lowercase.

**Password**: Use for simple access control when you don't need to track individual users or personalize content. Good for contractors, beta users, or temporary access scenarios.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L57

': U' should be in lowercase.

**Shared Session**: Use when you want seamless login between your application and documentation. Ideal when users are already authenticated in your main application and you want to personalize their documentation experience.

Check warning on line 59 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L59

': U' should be in lowercase.

Check warning on line 59 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L59

Use 'app' instead of 'application'.

Check warning on line 59 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/overview.mdx#L59

Use 'app' instead of 'application'.

## Content customization

Expand Down
2 changes: 1 addition & 1 deletion contact-support.mdx
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
---
title: "Contact support"
icon: "circle-help"
description: "We're here to help you get the most out of Mintlify"

Check warning on line 4 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L4

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

## Ask our docs

Check warning on line 7 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L7

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

Select <kbd>Command</kbd> + <kbd>I</kbd> to start a chat with our AI assistant trained on our documentation.

Check warning on line 9 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L9

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

Check warning on line 9 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L9

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

## Watch video tutorials

Visit our [YouTube](https://www.youtube.com/@GetMintlify/videos) channel for tutorials and guides on using Mintlify.

Check warning on line 13 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L13

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

## Message support

Send us a message from your [dashboard](https://dashboard.mintlify.com/) by selecting **Support** in the sidebar.

Check warning on line 17 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L17

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

![Gif showing how to access support from the dashboard by selecting the Support button, then selecting an option and typing a question in the support modal that pops up.](https://mintlify.s3.us-west-1.amazonaws.com/mintlify/images/support-flow.gif)
![GIF showing how to access support from the dashboard by selecting the Support button, then selecting an option and typing a question in the support modal that pops up.](https://mintlify.s3.us-west-1.amazonaws.com/mintlify/images/support-flow.gif)

Check warning on line 19 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L19

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

<Info>
We aim to respond to all requests within 24 hours, but delays may occur during busy times.

Check warning on line 22 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L22

Try to avoid using first-person plural like 'We'.
</Info>

## Email support

Check warning on line 25 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L25

Use 'email' instead of 'Email'.

If you can't access your dashboard, please email us at <a href="mailto:[email protected]">[email protected]</a>.

Check warning on line 27 in contact-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contact-support.mdx#L27

Try to avoid using first-person plural like 'us'.
6 changes: 3 additions & 3 deletions guides/claude-code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
## Getting started

**Prerequisites:**
- Active Claude subscription (Pro, Max, or API access)

Check warning on line 14 in guides/claude-code.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/claude-code.mdx#L14

Use parentheses judiciously.

**Setup:**
1. Install Claude Code:
Expand All @@ -19,7 +19,7 @@
npm install -g @anthropic-ai/claude-code
```
2. Navigate to your docs directory.
3. (Optional) Add the `CLAUDE.md` file below to your project.

Check warning on line 22 in guides/claude-code.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/claude-code.mdx#L22

Use parentheses judiciously.
4. Run `claude` to start.

## CLAUDE.md template
Expand All @@ -34,7 +34,7 @@
## Working relationship
- You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
- ALWAYS ask for clarification rather than making assumptions
- NEVER lie, guess, or make up information
- NEVER lie, guess, or make up anything

## Project context
- Format: MDX files with YAML frontmatter
Expand All @@ -43,9 +43,9 @@

## Content strategy
- Document just enough for user success - not too much, not too little
- Prioritize accuracy and usability of information
- Prioritize accuracy and usability
- Make content evergreen when possible
- Search for existing information before adding new content. Avoid duplication unless it is done for a strategic reason
- Search for existing content before adding anything new. Avoid duplication unless it is done for a strategic reason
- Check existing patterns for consistency
- Start by making the smallest reasonable changes

Expand Down Expand Up @@ -117,12 +117,12 @@
Create code examples for [your API endpoint] in JavaScript, Python, and cURL with error handling
```

## Extending Claude Code

Check warning on line 120 in guides/claude-code.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/claude-code.mdx#L120

'Extending Claude Code' should use sentence-style capitalization.

Beyond manually prompting Claude Code, you can integrate it with your existing workflows.

### Automation with GitHub Actions

Check warning on line 124 in guides/claude-code.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/claude-code.mdx#L124

'Automation with GitHub Actions' should use sentence-style capitalization.
Run Claude Code automatically when code changes to keep docs up to date. You can trigger documentation reviews on pull requests or update examples when API changes are detected.

Check warning on line 125 in guides/claude-code.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/claude-code.mdx#L125

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

### Multi-instance workflows
Use separate Claude Code sessions for different tasks - one for writing new content and another for reviewing and quality assurance. This helps maintain consistency and catch issues that a single session might miss.
Expand Down
2 changes: 1 addition & 1 deletion guides/hidden-pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
icon: "eye-closed"
---

Hidden pages are removed from your site's navigation but remain publicly accessible to anyone who knows their URL.

Check warning on line 7 in guides/hidden-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/hidden-pages.mdx#L7

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

Use hidden pages for content that you want to be accessible on your site or referenced as context for AI tools, but not discoverable through the navigation.

Expand All @@ -14,9 +14,9 @@

## Hiding a page

A page is hidden if it is not included in your `docs.json` navigation. To hide a page, remove it from your navigation structure.

Check warning on line 17 in guides/hidden-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/hidden-pages.mdx#L17

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

Check warning on line 17 in guides/hidden-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/hidden-pages.mdx#L17

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

Hidden pages use the same URL structure as regular pages based on their file path. For example, `guides/hidden-page.mdx` would be accessible at `docs.yoursite.com/guides/hidden-page`.
Hidden pages use the same URL structure as regular pages based on their file path. For example, `guides/hidden-page.mdx` would be accessible at `docs.yoursite.com/guides/hidden-page`.

Check warning on line 19 in guides/hidden-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/hidden-pages.mdx#L19

Use 'path' instead of 'file path'.

See an [example of a hidden page](/guides/hidden-page-example).

Expand All @@ -26,7 +26,7 @@

## Hiding a group of pages

A group of pages is hidden if the `hidden` property is set to `true` in your `docs.json` file:

Check warning on line 29 in guides/hidden-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/hidden-pages.mdx#L29

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

Check warning on line 29 in guides/hidden-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/hidden-pages.mdx#L29

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

```json highlight={4}
"groups": [
Expand All @@ -47,7 +47,7 @@
}
]
```
In this example, the `Getting started` group is hidden, but the `Guides` group is visible.

Check warning on line 50 in guides/hidden-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/hidden-pages.mdx#L50

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

### Hiding a tab

Expand All @@ -66,9 +66,9 @@
]
```

## Search, SEO, and AI indexing

Check warning on line 69 in guides/hidden-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/hidden-pages.mdx#L69

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

By default, hidden pages are excluded from indexing for search engines, internal search within your docs, and as context for the AI assistant. To include hidden pages in search results and as context for the assistant, add the `seo` property to your `docs.json`:

Check warning on line 71 in guides/hidden-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/hidden-pages.mdx#L71

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

```json
"seo": {
Expand Down
4 changes: 2 additions & 2 deletions settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@

<Expandable title="Fonts">
<ResponseField name="family" type="string" required>
Font family, such as "Open Sans", "Playfair Display."
Font family, such as "Open Sans."
</ResponseField>
<ResponseField name="weight" type="number">
Font weight, such as 400 or 700. Variable fonts support precise weights such as 550.
Expand All @@ -219,7 +219,7 @@
Font weight, such as 400, 700. Variable fonts support precise weights such as 550.
</ResponseField>
<ResponseField name="source" type="string (uri)">
URL to your font source, such as https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. [Google Fonts](https://fonts.google.com) are loaded automatically when you specify a Google Font `family` name, so no source URL is needed.

Check warning on line 222 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L222

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

Check warning on line 222 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L222

In general, use active voice instead of passive voice ('is needed').
</ResponseField>
<ResponseField name="format" type="&quot;woff&quot; | &quot;woff2&quot;">
Font file format.
Expand Down Expand Up @@ -343,7 +343,7 @@

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

<Expandable title="Global">
<ResponseField name="languages" type="array of object">
Expand Down Expand Up @@ -495,7 +495,7 @@

<Expandable title="Interaction">
<ResponseField name="drilldown" type="boolean">
Control automatic navigation behavior when selecting navigation groups. Set to `true` to force navigation to the first page when a navigation group is expanded. Set to `false` to prevent navigation and only expand or collapse the group. Leave unset to use the theme's default behavior.

Check warning on line 498 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L498

In general, use active voice instead of passive voice ('is expanded').
</ResponseField>
</Expandable>
</ResponseField>
Expand Down Expand Up @@ -572,7 +572,7 @@
Destination path to redirect to. Example: `/new-page`
</ResponseField>
<ResponseField name="permanent" type="boolean">
Whether to use a permanent redirect (301). Defaults to `true`.

Check warning on line 575 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L575

Use parentheses judiciously.
</ResponseField>
</Expandable>
</ResponseField>
Expand All @@ -583,13 +583,13 @@
<Expandable title="Contextual">
<ResponseField name="options" type="array of &quot;copy&quot; | &quot;view&quot; | &quot;chatgpt&quot; | &quot;claude&quot; | &quot;perplexity&quot; | &quot;mcp&quot; | &quot;cursor&quot; | &quot;vscode&quot;" required>
Actions available in the contextual menu. The first option appears as the default.
- `copy`: Copy the current page as Markdown to the clipboard.

Check warning on line 586 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L586

': C' should be in lowercase.
- `view`: View the current page as Markdown in a new tab.

Check warning on line 587 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L587

': V' should be in lowercase.
- `chatgpt`: Send the current page content to ChatGPT.

Check warning on line 588 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L588

': S' should be in lowercase.
- `claude`: Send the current page content to Claude.
- `perplexity`: Send the current page content to Perplexity.
- `mcp`: Copies your MCP server URL to the clipboard.
- `cursor`: Installs your hosted MCP server in Cursor.

Check warning on line 592 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L592

': I' should be in lowercase.
- `vscode`: Installs your hosted MCP server in VSCode.

<img src="/images/page-context-menu.png" alt="Contextual Menu" className="rounded-xl" />
Expand All @@ -602,7 +602,7 @@
</Expandable>
</ResponseField>

### API Configurations

Check warning on line 605 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L605

'API Configurations' should use sentence-style capitalization.

<ResponseField name="api" type="object">
API documentation and interactive playground settings.
Expand Down Expand Up @@ -698,10 +698,10 @@
</Expandable>
</ResponseField>

### SEO and search

Check warning on line 701 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L701

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

Check warning on line 701 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L701

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

<ResponseField name="seo" type="object">
SEO indexing configurations.

Check warning on line 704 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L704

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

<Expandable title="Seo">
<ResponseField name="metatags" type="object">
Expand Down Expand Up @@ -937,7 +937,7 @@
404 "Page not found" error handling.
<Expandable title="404">
<ResponseField name="redirect" type="boolean">
Whether to automatically redirect to the home page when a page is not

Check warning on line 940 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L940

Use 'isn't' instead of 'is not'.
found.
</ResponseField>
<ResponseField name="title" type="string">
Expand Down Expand Up @@ -1493,7 +1493,7 @@

</CodeGroup>

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

Check warning on line 1496 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L1496

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

Check warning on line 1496 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L1496

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

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

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

Check warning on line 1510 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L1510

Avoid using 'will'.
</Step>
<Step title="Delete your mint.json file">
After verifying your `docs.json` is configured properly, you can safely delete your old `mint.json` file.
Expand Down