Skip to content

Commit 060ac15

Browse files
authored
Fix vale errors (#1213)
* don't lint inside JSON examples * actually don't lint inside JSON snippets * update vocab * fix errors * update vocab * remove latin abbreviations * don't lint snippets * update vocab * don't lint in angle brackets * add language tags * update vocab * regexify vocab list * grammar
1 parent 6d9f2db commit 060ac15

File tree

10 files changed

+76
-43
lines changed

10 files changed

+76
-43
lines changed

.vale.ini

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ Vale.Avoid = NO # Too aggressive about common technical terms
2222
# Token and block ignores for MDX-specific syntax
2323
TokenIgnores = (?sm)((?:import|export) .+?$), \
2424
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
25-
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)
25+
(<[A-Z]\w+>.+?<\/[A-Z]\w+>), \
26+
(<[^>]*>)
2627

2728
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
2829
(?sm)^({.+.*})

.vale/styles/Google/Quotes.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ link: 'https://developers.google.com/style/quotation-marks'
44
level: error
55
nonword: true
66
tokens:
7-
- '"[^"]+"[.,?]'
7+
# Match quotes with trailing punctuation, but exclude content in JSON
8+
- '(?<!^\s*)"[^"]+"[.,?](?!\s*$)'

.vale/styles/config/vocabularies/Mintlify/accept.txt

Lines changed: 60 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,83 +8,87 @@ bearerAuth
88
borderRadius
99
camelCase
1010
discoverability
11-
callout
12-
Callouts
13-
callouts
11+
(?i)callouts?
1412
drilldown
1513
expandables
1614
favicon
1715
isHidden
18-
Mintlify
19-
mintlify
20-
modeToggle
21-
ModeToggle
16+
(?i)mintlify
17+
(?i)modetoggle
2218
myName
2319
myObject
2420
onboarding
25-
openapi
26-
OpenAPI
21+
(?i)openapi
2722
repo
2823
topbar
29-
tooltip
30-
Tooltip
31-
tooltips
24+
(?i)tooltips?
3225
url
3326

3427
# =============================================================================
35-
# PROGRAMMING LANGUAGES & FRAMEWORKS
28+
# NAMES OF THINGS
3629
# =============================================================================
3730
Angular
3831
AWS
3932
Azure
40-
Babel
41-
babel
33+
(?i)babel
4234
Bitbucket
35+
(?i)chatgpt
36+
(?i)claude
37+
CloudFront
4338
Chromium
4439
CircleCI
40+
Clearbit
41+
Ctrl
4542
Cypress
4643
Django
4744
DynamoDB
4845
Elasticsearch
49-
ESLint
50-
eslint
46+
Entra
47+
(?i)eslint
5148
Express
5249
Firefox
5350
Flask
5451
GCP
55-
Git
56-
git
52+
(?i)git
5753
GitHub
5854
GitLab
5955
Go
6056
Golang
6157
GraphQL
6258
Heroku
59+
Hightouch
6360
IntelliJ
6461
Java
6562
JavaScript
66-
Jest
67-
jest
63+
(?i)jest
6864
JSDoc
6965
Kotlin
7066
Kubernetes
7167
Laravel
7268
Linux
69+
LLMs
70+
Lucide
7371
macOS
72+
(?i)mcp
7473
MDX
74+
Mixpanel
7575
Mocha
7676
MongoDB
7777
MySQL
7878
Next.js
7979
Node.js
8080
NodeJS
81+
npx
8182
Nuxt
8283
OAuth
84+
Okta
85+
Osano
86+
Pirsch
8387
PNPM
88+
Posthog
8489
Postman
8590
PostgreSQL
86-
Prettier
87-
prettier
91+
(?i)prettier
8892
Python
8993
React
9094
Redis
@@ -100,27 +104,29 @@ Terraform
100104
TypeDoc
101105
TypeScript
102106
Unix
103-
Vercel
104-
vercel
105-
Vite
106-
vite
107+
(?i)vercel
108+
(?i)vite
107109
Visual Studio Code
108110
VS Code
111+
vscode
109112
Vue
110113
Vuex
111114
Webflow
112115
WebKit
113-
Webpack
114-
webpack
116+
(?i)webpack
115117
WebStorm
118+
Zapier
116119

117120
# =============================================================================
118121
# TERMS
119122
# =============================================================================
123+
agentic
120124
allowlist
121125
APIs
122126
args
123127
async
128+
autogenerated
129+
autogenerating
124130
await
125131
bool
126132
boolean
@@ -145,14 +151,18 @@ elem
145151
enum
146152
env
147153
err
154+
favicons
148155
func
156+
frontmatter
157+
Gantt
149158
gui
150159
href
151160
html
152161
http
153162
https
154163
ide
155164
impl
165+
ingestible
156166
init
157167
instanceof
158168
jvm
@@ -164,6 +174,7 @@ md
164174
middleware
165175
Multiline
166176
mvc
177+
monorepo
167178
nav
168179
next
169180
nodejs
@@ -175,16 +186,22 @@ orm
175186
params
176187
pnpm
177188
png
189+
prepend
190+
prepended
178191
prev
179192
proc
193+
proxied
194+
proxying
180195
ptr
181196
pytest
182197
req
183198
res
184199
rpc
185200
runtime
186201
scss
202+
SDKs
187203
sdk
204+
serverless
188205
Singleline
189206
sql
190207
ssh
@@ -194,16 +211,23 @@ stdin
194211
stdout
195212
Strikethrough
196213
struct
214+
subpaths
215+
subschema
216+
Subscribable
217+
subscribable
218+
SVGs
197219
svg
198220
tcp
199221
tls
200222
tmp
201223
toc
202224
todo
225+
transpilation
203226
tsx
204227
TTL
205228
typeof
206229
ui
230+
uncached
207231
undefined
208232
uri
209233
ux
@@ -217,3 +241,10 @@ xhr2
217241
yaml
218242
yarn
219243
yml
244+
245+
# =============================================================================
246+
# LOCALIZATION
247+
# =============================================================================
248+
cn
249+
ko
250+
ru

advanced/dashboard/sso.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Use single sign-on to your dashboard via SAML and OIDC. If you use Okta, Google
4545
</Step>
4646
<Step title="Send us your IdP information">
4747
Once the application is set up, navigate to the General tab and locate the client ID & client secret.
48-
Please securely provide us with these, along with your Okta instance URL (e.g. `<your-tenant-name>.okta.com`). You can send these via a service like 1Password or SendSafely.
48+
Please securely provide us with these, along with your Okta instance URL (for example, `<your-tenant-name>.okta.com`). You can send these via a service like 1Password or SendSafely.
4949
</Step>
5050
</Steps>
5151
</Tab>
@@ -97,7 +97,7 @@ Use single sign-on to your dashboard via SAML and OIDC. If you use Okta, Google
9797
<Tab title="SAML">
9898
<Steps>
9999
<Step title="Create an application">
100-
1. Under "Enterprise applications", select **New application**.
100+
1. Under "Enterprise applications," select **New application**.
101101
2. Select **Create your own application** and choose "Integrate any other application you don't find in the gallery (Non-gallery)."
102102
</Step>
103103
<Step title="Configure SAML">

advanced/subpath/route53-cloudfront.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ All Behaviors must have the an **origin request policy** of `AllViewerExceptHost
7070
If you use Vercel, use the `.vercel.app` domain available for every project.
7171
</Info>
7272

73-
3. Create a new Origin and add your staging URL as the "Origin domain".
73+
3. Create a new Origin and add your staging URL as the "Origin domain."
7474

7575
<Frame>
7676
![CloudFront "Create origin" page with a "Origin domain" input field highlighted.](/images/cloudfront/default-origin.png)
@@ -101,7 +101,7 @@ Behaviors in CloudFront enable control over the subpath logic. At a high level,
101101

102102
Create behaviors for Vercel domain verification paths with a **Path pattern** of `/.well-known/*` and set **Origin and origin groups** to your docs URL.
103103

104-
For "Cache policy", select **CachingDisabled** to ensure these verification requests pass through without caching.
104+
For "Cache policy," select **CachingDisabled** to ensure these verification requests pass through without caching.
105105

106106
<Frame>
107107
![CloudFront "Create behavior" page with a "Path pattern" of "/.well-known/*" and "Origin and origin groups" pointing to the staging URL.](/images/cloudfront/well-known-policy.png)

changelog.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ noindex: true
184184
## API playground enhancements
185185

186186
- New [Search API endpoint](https://mintlify.com/docs/api-reference/assistant/search) so you can build agents and MCP servers on top of your docs
187-
- `openapi` and `asyncapi` files are now served at their specified paths (e.g. `https://mydocsurl.extension/{openapi-or-file-name}.json`)
187+
- `openapi` and `asyncapi` files are now served at their specified paths (for example, `https://mydocsurl.extension/{openapi-or-file-name}.json`)
188188
- You can now use the [`x-mint` field in your openapi files](https://mintlify.com/docs/api-playground/openapi-setup#x-mint-extension) to override generated fields, customize preface content, or change endpoint URLs in code samples
189189
- [`x-mcp` is now `x-mint.mcp`](https://mintlify.com/docs/api-playground/openapi-setup#mcp) in OpenAPI configurations to control which routes are exposed as MCP tools
190190

@@ -426,7 +426,7 @@ noindex: true
426426
## AI Assistant Improvements
427427

428428
- New UI with dedicated chat page & pre-filled prompts
429-
- Stability improvements, e.g. bug fixes of editing the wrong file or no files at all
429+
- Stability improvements. For example, bug fixes of editing the wrong file or no files at all
430430
- More robust knowledge for adding & editing components
431431
- Improved `docs.json` file editing
432432

@@ -439,7 +439,7 @@ noindex: true
439439
We’ve overhauled the design and performance of the [API Playground](/api-playground/). Updates include:
440440

441441
- Easier detail expansion for an overview of a field
442-
- More intuitive nested design, e.g. adding or deleting items
442+
- More intuitive nested design. For example, adding or deleting items
443443
- Faster response times
444444

445445
## Quality Improvements

components/cards.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Use the [Columns component](/components/columns) to organize multiple cards side
107107
<IconsOptional />
108108

109109
<ResponseField name="color" type="string">
110-
Icon color as a hex code (e.g., `#FF6B6B`).
110+
Icon color as a hex code (for example, `#FF6B6B`).
111111
</ResponseField>
112112

113113
<ResponseField name="href" type="string">

guides/auth0.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This guide walks you through setting up Auth0 as an authentication provider for
1313

1414
<Steps>
1515
<Step title="Create a Regular Web Application in Auth0">
16-
Log in to your Auth0 dashboard and navigate to **Applications** > **Applications**. Click the **Create Application** button, give your application a name (e.g., "Mintlify"), and select **Regular Web Applications** as the application type. Then click **Create**.
16+
Log in to your Auth0 dashboard and navigate to **Applications** > **Applications**. Click the **Create Application** button, give your application a name (for example, "Mintlify"), and select **Regular Web Applications** as the application type. Then click **Create**.
1717

1818
<Frame>![Creating a new application in Auth0](/images/guides/auth0/auth0-create-application.png)</Frame>
1919
</Step>
@@ -23,7 +23,7 @@ This guide walks you through setting up Auth0 as an authentication provider for
2323
<Frame>![Auth0 client settings page](/images/guides/auth0/auth0clientsettings.png)</Frame>
2424

2525
Make note of the following information:
26-
- **Domain**: This is your Auth0 tenant domain (e.g., `your-tenant.auth0.com`)
26+
- **Domain**: This is your Auth0 tenant domain (for example, `your-tenant.auth0.com`)
2727
- **Client ID**: The public identifier for your application
2828
- **Client Secret**: The secret key for your application (keep this secure)
2929

image-embeds.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Use [Markdown syntax](https://www.markdownguide.org/basic-syntax/#images) to add
3232
Always include descriptive alt text to improve accessibility and SEO. The alt text should clearly describe what the image shows.
3333
</Tip>
3434

35-
Image files must be less than 20MB. For larger files, host them on a CDN service like [Amazon S3](https://aws.amazon.com/s3) or [Cloudinary](https://cloudinary.com).
35+
Image files must be less than 20 MB. For larger files, host them on a CDN service like [Amazon S3](https://aws.amazon.com/s3) or [Cloudinary](https://cloudinary.com).
3636

3737
### HTML image embeds
3838

installation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ You can use the CLI to check your OpenAPI file for errors using the following co
116116
mint openapi-check <openapiFilenameOrUrl>
117117
```
118118

119-
You can pass in a filename (e.g. `./openapi.yaml`) or a URL (e.g. `https://petstore3.swagger.io/api/v3/openapi.json`).
119+
You can pass in a filename (for example, `./openapi.yaml`) or a URL (for example, `https://petstore3.swagger.io/api/v3/openapi.json`).
120120

121121
### Renaming files
122122

0 commit comments

Comments
 (0)