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
3 changes: 3 additions & 0 deletions .vale/styles/Mintlify/Acronyms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ exceptions:
- PHP
- PNG
- POST
- PST
- RAG
- RAM
- REPL
Expand All @@ -59,6 +60,7 @@ exceptions:
- SCM
- SCSS
- SDK
- SLA
- SQL
- SSH
- SSL
Expand All @@ -72,6 +74,7 @@ exceptions:
- URL
- USB
- UTF
- VPN
- WOFF
- XML
- XSS
Expand Down
4 changes: 4 additions & 0 deletions .vale/styles/Mintlify/Headings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,19 @@ indicators:
exceptions:
- Azure
- CLI
- CSM
- Discord
- Docker
- Emmet
- FAQ
- I
- Kubernetes
- Linux
- macOS
- Marketplace
- MongoDB
- REPL
- Slack
- Studio
- TypeScript
- URL
Expand Down
4 changes: 2 additions & 2 deletions advanced-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

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.

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

Expand All @@ -24,7 +24,7 @@

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

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

Expand All @@ -45,7 +45,7 @@

<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:
We deliver standard support 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:

- **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 Down Expand Up @@ -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:
We deliver standard support (included with Pro and Enterprise plans) via the dashboard or support@mintlify.com with a 24-48 hour response SLA. Advanced Slack support includes:

- Dedicated Slack channel versus email/dashboard support
- 24-hour response SLA versus 24-48 hours for standard support
Expand Down
2 changes: 1 addition & 1 deletion agent/use-cases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ For example: `@mintlify Users are getting confused by step 3 in the setup guide.

## Automate with workflows

Create workflows to automate recurring tasks and reactive maintenance tasks like writing changelogs or updating content when new features are added to your product.
Create workflows to automate recurring tasks and reactive maintenance tasks like writing changelogs or updating content when you add new features to your product.

See [Workflows](/agent/workflows) for more information.

Expand Down
2 changes: 1 addition & 1 deletion ai/model-context-protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
Mintlify generates an MCP server for your documentation and hosts it at the `/mcp` path of your documentation URL. For example, Mintlify's MCP server is available at `https://mintlify.com/docs/mcp`.

* For public documentation, your MCP server is available to anyone. It searches all indexed public pages.
* For documentation with partial authentication, where some pages are public and others are protected, you must enable your MCP server before it is available to users. Unauthenticated users can search public content. Users who authenticate can search all content they have permission to access based on their [user groups](/deploy/authentication-setup).
* For documentation with partial authentication, where some pages are public and others require login, you must enable your MCP server before users can access it. Unauthenticated users can search public content. Users who authenticate can search all content they have permission to access based on their [user groups](/deploy/authentication-setup).
* For documentation where all pages require authentication, you must enable your MCP server before it is available to users. Users must authenticate before connecting to your MCP server. Your MCP server searches only the content each user has access to based on their [user groups](/deploy/authentication-setup).

View and copy your MCP server URL on the [MCP server page](https://dashboard.mintlify.com/products/mcp) in your dashboard.
Expand All @@ -66,7 +66,7 @@

If your documentation has partial authentication with both public and protected pages, users can connect to your MCP server without authenticating to access public content. Users who authenticate gain access to protected content available to them.

By default, your MCP server is only available for localhost tools. To allow web-based tools to connect, add the redirect domains for the AI tools. A redirect domain is the hostname that an AI tool uses after a user completes authentication like `claude.ai` or `app.cursor.ai`. Your users' AI tools cannot complete authentication unless their redirect domain is on this list.

Check warning on line 69 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L69

Did you really mean 'hostname'?

<Steps>
<Step title="Enable authenticated MCP in your dashboard">
Expand Down
2 changes: 1 addition & 1 deletion installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ Identify broken links in your documentation:
mint broken-links
```

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

By default, the command checks only internal links. Use flags to expand the scope:

Expand Down
4 changes: 2 additions & 2 deletions organize/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,11 @@

Use the `expanded` property to control the default state of a nested group in the navigation sidebar.

- `expanded: true`: Group is expanded by default.

Check warning on line 123 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L123

In general, use active voice instead of passive voice ('is expanded').
- `expanded: false` or omitted: Group is collapsed by default.

Check warning on line 124 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L124

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

<Note>
The `expanded` property only affects nested groups--groups within groups. Top-level groups are always expanded and cannot be collapsed.

Check warning on line 127 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L127

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

```json
Expand Down Expand Up @@ -517,7 +517,7 @@

### Default version

The first version in the `versions` array is used as the default version. Use the `default` field to specify a different version as the default.
Mintlify uses the first version in the `versions` array as the default. Use the `default` field to specify a different version as the default.

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

## Nesting

Navigation elements can be nested within each other to create complex hierarchies. You must have one root-level parent navigation element such as tabs, groups, or a dropdown. You can nest other types of navigation elements within your primary navigation pattern.
You can nest navigation elements within each other to create complex hierarchies. You must have one root-level parent navigation element such as tabs, groups, or a dropdown. You can nest other types of navigation elements within your primary navigation pattern.

Each navigation element can contain one type of child element at each level of your navigation hierarchy. For example, a tab can contain anchors that contain groups, but a tab cannot contain both anchors and groups at the same level.

Expand Down
4 changes: 2 additions & 2 deletions organize/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -348,11 +348,11 @@ This section contains the full reference for the `docs.json` file.
</ResponseField>

<ResponseField name="variables" type="object">
Global variables for use throughout your documentation. Variables are replaced at build time using `{{variableName}}` syntax.
Global variables for use throughout your documentation. Mintlify replaces variables at build time using `{{variableName}}` syntax.

<Expandable title="Variables">
<ResponseField name="variableName" type="string">
A key-value pair where the key is the variable name and the value is the replacement text. All variables referenced in your content must be defined, or the build fails. Variable names can contain alphanumeric characters, hyphens, and periods. Values are sanitized to prevent XSS attacks.
A key-value pair where the key is the variable name and the value is the replacement text. You must define all variables referenced in your content, or the build fails. Variable names can contain alphanumeric characters, hyphens, and periods. Mintlify sanitizes values to prevent XSS attacks.
</ResponseField>
</Expandable>
</ResponseField>
Expand Down
Loading