diff --git a/.vale/styles/Mintlify/Acronyms.yml b/.vale/styles/Mintlify/Acronyms.yml index 0f1792b20..51ac9e427 100644 --- a/.vale/styles/Mintlify/Acronyms.yml +++ b/.vale/styles/Mintlify/Acronyms.yml @@ -51,6 +51,7 @@ exceptions: - PHP - PNG - POST + - PST - RAG - RAM - REPL @@ -59,6 +60,7 @@ exceptions: - SCM - SCSS - SDK + - SLA - SQL - SSH - SSL @@ -72,6 +74,7 @@ exceptions: - URL - USB - UTF + - VPN - WOFF - XML - XSS diff --git a/.vale/styles/Mintlify/Headings.yml b/.vale/styles/Mintlify/Headings.yml index 603970c0a..82563cf9f 100644 --- a/.vale/styles/Mintlify/Headings.yml +++ b/.vale/styles/Mintlify/Headings.yml @@ -8,8 +8,11 @@ indicators: exceptions: - Azure - CLI + - CSM + - Discord - Docker - Emmet + - FAQ - I - Kubernetes - Linux @@ -17,6 +20,7 @@ exceptions: - Marketplace - MongoDB - REPL + - Slack - Studio - TypeScript - URL diff --git a/advanced-support.mdx b/advanced-support.mdx index 905f63ddc..591ae660d 100644 --- a/advanced-support.mdx +++ b/advanced-support.mdx @@ -45,7 +45,7 @@ Get an assigned Customer Success Manager who knows your team, setup, and goals. - 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 @@ -82,7 +82,7 @@ Get an assigned Customer Success Manager who knows your team, setup, and goals. - 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 diff --git a/agent/use-cases.mdx b/agent/use-cases.mdx index 8e60eff40..12d520353 100644 --- a/agent/use-cases.mdx +++ b/agent/use-cases.mdx @@ -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. diff --git a/ai/model-context-protocol.mdx b/ai/model-context-protocol.mdx index 938203009..0cd1107fd 100644 --- a/ai/model-context-protocol.mdx +++ b/ai/model-context-protocol.mdx @@ -46,7 +46,7 @@ AI tools can search the web, but MCP provides distinct advantages for documentat 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. diff --git a/installation.mdx b/installation.mdx index e55113e55..6ff70f426 100644 --- a/installation.mdx +++ b/installation.mdx @@ -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: diff --git a/organize/navigation.mdx b/organize/navigation.mdx index 467fddffa..7cf186f4d 100644 --- a/organize/navigation.mdx +++ b/organize/navigation.mdx @@ -517,7 +517,7 @@ In the `navigation` object, `versions` is an array where each entry is an object ### 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 { @@ -727,7 +727,7 @@ For automated translations, [contact our sales team](mailto:gtm@mintlify.com) to ## 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. diff --git a/organize/settings.mdx b/organize/settings.mdx index 0dc8b6e9e..17893be5c 100644 --- a/organize/settings.mdx +++ b/organize/settings.mdx @@ -348,11 +348,11 @@ This section contains the full reference for the `docs.json` file. - 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. - 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.