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
2 changes: 1 addition & 1 deletion advanced-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,31 @@

## Support options

- All customers receive support via dashboard or support@mintlify.com (24 hour response)

Check warning on line 9 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L9

Use parentheses judiciously.
- Enterprise plan customers can add Advanced Slack support (24-hour response) or a dedicated CSM (4-hour response + strategic partnership)

Check warning on line 10 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L10

Use parentheses judiciously.

Check warning on line 10 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L10

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

### Standard support (included)

Check warning on line 12 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L12

Use parentheses judiciously.

Included with all Pro and Enterprise plans. Submit tickets through the dashboard or email support@mintlify.com. First response within 24-48 hours.

### Advanced Slack support (Add-on)

Check warning on line 16 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L16

'Advanced Slack support (Add-on)' should use sentence-style capitalization.

Check warning on line 16 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L16

Use parentheses judiciously.

Get a dedicated Slack channel with our support team for faster troubleshooting.

**What you get:**
- Slack channel for your team and Mintlify support engineers
- 24-hour first response SLA

Check warning on line 22 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L22

Spell out 'SLA', if it's unfamiliar to the audience.
- Expedited bug escalation to the Mintlify engineering team

**Best for:** Teams that need faster response times but don't require strategic partnership or scheduled check-ins.

### Dedicated CSM (Add-on)

Check warning on line 27 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L27

'Dedicated CSM (Add-on)' should use sentence-style capitalization.

Check warning on line 27 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L27

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

Check warning on line 27 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L27

Use parentheses judiciously.

Get an assigned Customer Success Manager who knows your team, setup, and goals.

**What you get:**
- Assigned CSM as your primary contact

Check warning on line 32 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L32

Spell out 'CSM', if it's unfamiliar to the audience.
- 4-hour first response SLA (9AM-5PM PST for US customers, 24 hours international)
- 4-hour first response SLA (9 AM-5 PM PST for US customers, 24 hours international)

Check warning on line 33 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L33

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

Check warning on line 33 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L33

Use parentheses judiciously.

Check warning on line 33 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L33

Spell out 'PST', if it's unfamiliar to the audience.
- Dedicated Slack channel
- Monthly check-ins
- Quarterly business reviews
Expand All @@ -39,13 +39,13 @@

**Best for:** Teams that need fast responses, proactive guidance, and influence over the product roadmap.

## FAQ

Check warning on line 42 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L42

'FAQ' should use sentence-style capitalization.

### Dedicated CSM

Check warning on line 44 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L44

'Dedicated CSM' should use sentence-style capitalization.

Check warning on line 44 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L44

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

<AccordionGroup>
<Accordion title="What's the difference between a dedicated CSM and standard support?">
Standard support is delivered via the dashboard or support@mintlify.com with a 24-48 hour response SLA. A Dedicated CSM includes both a primary point of contact and a dedicated Slack channel. The main differences are:

Check warning on line 48 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L48

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

Check warning on line 48 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L48

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

Check warning on line 48 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L48

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

- **Response time:** 4 hours for US customers during business hours versus 24-48 hours for standard support
- **Relationship:** One person who knows your setup versus a support team rotation
Expand All @@ -67,7 +67,7 @@
</Accordion>

<Accordion title="How does feature request tracking work?">
Every dedicated CSM customer gets a shared Google Sheet tracker where you can:

Check warning on line 70 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L70

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

- Submit feature requests with context and priority
- See status updates as requests move through review and development
Expand All @@ -82,7 +82,7 @@

<AccordionGroup>
<Accordion title="What's the difference between advanced Slack support and standard support?">
Standard support (included with Pro and Enterprise plans) is delivered via the dashboard or support@mintlify.com with a 24-48 hour response SLA. Advanced Slack support includes:

Check warning on line 85 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L85

Use parentheses judiciously.

Check warning on line 85 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L85

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

Check warning on line 85 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L85

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

- Dedicated Slack channel versus email/dashboard support
- 24-hour response SLA versus 24-48 hours for standard support
Expand All @@ -90,10 +90,10 @@
</Accordion>

<Accordion title="Why is advanced Slack support priced separately?">
You're getting a dedicated Slack channel with our support team plus expedited engineering escalation for bugs and incidents—not email support with 24-48 hour response times. This is premium support for teams that need faster answers without the full strategic CSM relationship.

Check warning on line 93 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L93

Spell out 'CSM', if it's unfamiliar to the audience.
</Accordion>
</AccordionGroup>

## Get started

Contact your Mintlify account team to add advanced Slack support or a dedicated CSM, or email gtm@mintlify.com.

Check warning on line 99 in advanced-support.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

advanced-support.mdx#L99

Spell out 'CSM', if it's unfamiliar to the audience.
2 changes: 1 addition & 1 deletion api-playground/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -132,14 +132,14 @@
Whether to prefill the API playground with data from schema examples. When enabled, the playground automatically populates request fields with example values from your OpenAPI specification. Defaults to `false`.
</ResponseField>
<ResponseField name="autogenerate" type="boolean">
Whether to generate code samples for endpoints from API specifications. Defaults to `true`. When set to `false`, only manually-written code samples (from `x-codeSamples` in OpenAPI specifications or `<RequestExample>` components in MDX) appear in the API playground.
Whether to generate code samples for endpoints from API specifications. Defaults to `true`. When set to `false`, only manually written code samples (from `x-codeSamples` in OpenAPI specifications or `<RequestExample>` components in MDX) appear in the API playground.
</ResponseField>
</Expandable>
</ResponseField>

### Example configuration

This example configures the API playground to be interactive with example code snippets for cURL, Python, and JavaScript. Only required parameters are shown in the code snippets, and the playground prefills the request body with example values.

Check warning on line 142 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L142

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

Check warning on line 142 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L142

Did you really mean 'prefills'?

```json
{
Expand All @@ -162,7 +162,7 @@

When `display` is set to `auth`:
- Authenticated users see the interactive playground.
- Unauthenticated users see no playground (equivalent to `none`).

Check warning on line 165 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L165

Use parentheses judiciously.

You can also combine `auth` with the `groups` property in page frontmatter to restrict playground access to specific user groups.

Expand All @@ -177,14 +177,14 @@
```

In this example:
- The page is publicly visible (anyone can view the documentation).

Check warning on line 180 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L180

Use parentheses judiciously.
- Only authenticated users in the `admin` or `developer` groups see the interactive playground.
- Users not in those groups see no playground.

If the page has no `groups` property, all authenticated users see the interactive playground.

<Note>
The `auth` display mode requires [authentication](/deploy/authentication-setup) to be configured for your documentation.

Check warning on line 187 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L187

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

### Custom endpoint pages
Expand All @@ -197,13 +197,13 @@
- Add additional content like examples
- Control playground behavior per page

The `x-mint` extension is recommended so that all of your API documentation is automatically generated from your OpenAPI specification and maintained in one file.

Check warning on line 200 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L200

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

Individual MDX pages are recommended for small APIs or when you want to experiment with changes on a per-page basis.

Check warning on line 202 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L202

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

## Further reading

- [OpenAPI setup](/api-playground/openapi-setup) for more information on creating your OpenAPI document.
- [x-mint extension](/api-playground/openapi-setup#customize-your-endpoint-pages) for more information on customizing your endpoint pages.
- [MDX setup](/api-playground/mdx-setup) for more information on manually creating individual API reference pages.
- [AsyncAPI setup](/api-playground/asyncapi-setup) for more information on creating your AsyncAPI schema to generate WebSocket reference pages.

Check warning on line 209 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L209

Use 'websockets?' instead of 'WebSocket'.
2 changes: 1 addition & 1 deletion installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@
alt="Decorative graphic representing the CLI."
/>

Use the [CLI](https://www.npmjs.com/package/mint) to preview your documentation locally as you write and edit. View changes in real-time before deploying, test your documentation site's appearance and functionality, and catch issues like broken links or accessibility problems.

Check warning on line 18 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L18

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

The CLI also has utilities for maintaining your documentation, including commands to rename files, validate OpenAPI specifications, and migrate content between formats.

## Prerequisites

- [Node.js](https://nodejs.org/en) v20.17.0+ (LTS versions recommended) installed

Check warning on line 24 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L24

Use parentheses judiciously.

Check warning on line 24 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L24

Spell out 'LTS', if it's unfamiliar to the audience.
- [Git](https://git-scm.com/downloads) installed
- Your documentation repository cloned locally

Expand Down Expand Up @@ -181,7 +181,7 @@
mint broken-links
```

The command ignores files matching [.mintignore](/organize/mintignore) patterns. Links that point to ignored files are reported as broken.

Check warning on line 184 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L184

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

To also check anchor links like `/path/to/page#anchor`, use the `--check-anchors` flag:

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

Use flags to configure the validation command.

- `--groups [groupname]`: Mock user groups for validation (useful when testing group-based access control)

Check warning on line 220 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L220

Use parentheses judiciously.
- `--disable-openapi`: Disable OpenAPI file generation during validation

### Check OpenAPI spec
Expand All @@ -228,7 +228,7 @@
mint openapi-check <OpenAPI filename or URL>
```

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

Check warning on line 231 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L231

Use parentheses judiciously.

### Rename files

Expand Down Expand Up @@ -262,7 +262,7 @@
<Accordion title='Error: Could not load the "sharp" module using the darwin-arm64 runtime'>
This may be due to an outdated version of Node.js. Try the following:

1. Remove the currently-installed version of the mint CLI: `npm uninstall -g mint`
1. Remove the currently installed version of the mint CLI: `npm uninstall -g mint`
2. Upgrade to Node.js v20.17.0+.
3. Reinstall the mint CLI: `npm install -g mint`
</Accordion>
Expand Down Expand Up @@ -300,7 +300,7 @@
```
</Accordion>
<Accordion title="Client version shows 'none' after installation">
If you run `mint version` and the client version displays as `none`, the CLI may be unable to download the client application due to a corporate firewall or VPN blocking the download.

Check warning on line 303 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L303

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

**Solution:** Ask your IT administrator to whitelist `releases.mintlify.com` to enable local development with the CLI.
</Accordion>
Expand Down
2 changes: 1 addition & 1 deletion organize/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -643,7 +643,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 646 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L646

Use parentheses judiciously.
</ResponseField>
</Expandable>
</ResponseField>
Expand Down Expand Up @@ -833,7 +833,7 @@
Whether to prefill the API playground with data from schema examples. When enabled, the playground automatically populates request fields with example values from your OpenAPI specification. Defaults to `false`.
</ResponseField>
<ResponseField name="autogenerate" type="boolean">
Whether to generate code samples for endpoints from API specifications. Defaults to `true`. When set to `false`, only manually-written code samples (from `x-codeSamples` in OpenAPI specifications or `<RequestExample>` components in MDX) appear in the API playground.
Whether to generate code samples for endpoints from API specifications. Defaults to `true`. When set to `false`, only manually written code samples (from `x-codeSamples` in OpenAPI specifications or `<RequestExample>` components in MDX) appear in the API playground.
</ResponseField>
</Expandable>
</ResponseField>
Expand Down