Skip to content

Commit 1941f2c

Browse files
Fix Vale style warnings from CI checks (#4348)
* Fix Vale style warnings from recent PRs Generated-By: mintlify-agent * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm --------- Co-authored-by: mintlify-development[bot] <109878554+mintlify-development[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
1 parent b591e74 commit 1941f2c

8 files changed

Lines changed: 16 additions & 9 deletions

File tree

.vale/styles/Mintlify/Acronyms.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ exceptions:
5151
- PHP
5252
- PNG
5353
- POST
54+
- PST
5455
- RAG
5556
- RAM
5657
- REPL
@@ -59,6 +60,7 @@ exceptions:
5960
- SCM
6061
- SCSS
6162
- SDK
63+
- SLA
6264
- SQL
6365
- SSH
6466
- SSL
@@ -72,6 +74,7 @@ exceptions:
7274
- URL
7375
- USB
7476
- UTF
77+
- VPN
7578
- WOFF
7679
- XML
7780
- XSS

.vale/styles/Mintlify/Headings.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,19 @@ indicators:
88
exceptions:
99
- Azure
1010
- CLI
11+
- CSM
12+
- Discord
1113
- Docker
1214
- Emmet
15+
- FAQ
1316
- I
1417
- Kubernetes
1518
- Linux
1619
- macOS
1720
- Marketplace
1821
- MongoDB
1922
- REPL
23+
- Slack
2024
- Studio
2125
- TypeScript
2226
- URL

advanced-support.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Get an assigned Customer Success Manager who knows your team, setup, and goals.
4545

4646
<AccordionGroup>
4747
<Accordion title="What's the difference between a dedicated CSM and standard support?">
48-
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:
48+
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:
4949

5050
- **Response time:** 4 hours for US customers during business hours versus 24-48 hours for standard support
5151
- **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.
8282

8383
<AccordionGroup>
8484
<Accordion title="What's the difference between advanced Slack support and standard support?">
85-
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:
85+
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:
8686

8787
- Dedicated Slack channel versus email/dashboard support
8888
- 24-hour response SLA versus 24-48 hours for standard support

agent/use-cases.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ For example: `@mintlify Users are getting confused by step 3 in the setup guide.
6262

6363
## Automate with workflows
6464

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

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

ai/model-context-protocol.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ AI tools can search the web, but MCP provides distinct advantages for documentat
4646
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`.
4747

4848
* For public documentation, your MCP server is available to anyone. It searches all indexed public pages.
49-
* 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).
49+
* 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).
5050
* 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).
5151

5252
View and copy your MCP server URL on the [MCP server page](https://dashboard.mintlify.com/products/mcp) in your dashboard.

installation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ Identify broken links in your documentation:
181181
mint broken-links
182182
```
183183

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

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

organize/navigation.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -517,7 +517,7 @@ In the `navigation` object, `versions` is an array where each entry is an object
517517

518518
### Default version
519519

520-
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.
520+
Mintlify uses the first version in the `versions` array as the default. Use the `default` field to specify a different version as the default.
521521

522522
```json
523523
{
@@ -727,7 +727,7 @@ For automated translations, [contact our sales team](mailto:gtm@mintlify.com) to
727727

728728
## Nesting
729729

730-
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.
730+
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.
731731

732732
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.
733733

organize/settings.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -348,11 +348,11 @@ This section contains the full reference for the `docs.json` file.
348348
</ResponseField>
349349

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

353353
<Expandable title="Variables">
354354
<ResponseField name="variableName" type="string">
355-
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.
355+
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.
356356
</ResponseField>
357357
</Expandable>
358358
</ResponseField>

0 commit comments

Comments
 (0)