Skip to content

Commit de81c2a

Browse files
committed
Merge branch 'locadex/mintlify-setup-1758153071498' of https://github.com/mintlify/docs into locadex/mintlify-setup-1758153071498
2 parents b74c8dc + c1f8804 commit de81c2a

File tree

10 files changed

+62
-18
lines changed

10 files changed

+62
-18
lines changed

.vale.ini

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,16 @@ Vale.Avoid = NO # Too aggressive about common technical terms
2323
TokenIgnores = (?sm)((?:import|export) .+?$), \
2424
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
2525
(<[A-Z]\w+>.+?<\/[A-Z]\w+>), \
26-
(<[^>]*>)
26+
(<[^>]*>), \
27+
\{[^}]*\}, \
28+
(`[^`]*`), \
29+
(```[\s\S]*?```)
2730

2831
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
29-
(?sm)^({.+.*})
32+
(?sm)^({.+.*})$, \
33+
(?sm)^```[\s\S]*?```$
3034

31-
CommentDelimiters = {/*, */}
35+
CommentDelimiters = {/*, */}
36+
37+
[changelog.mdx]
38+
BasedOnStyles =

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

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@
33
# =============================================================================
44
# MINTLIFY-SPECIFIC TERMS
55
# =============================================================================
6+
APISection
67
autoplay
78
bearerAuth
89
borderRadius
910
camelCase
1011
discoverability
1112
(?i)callouts?
13+
CTAs
1214
drilldown
1315
expandables
1416
favicon
@@ -17,9 +19,11 @@ isHidden
1719
(?i)modetoggle
1820
myName
1921
myObject
22+
navbar
2023
onboarding
2124
(?i)openapi
2225
repo
26+
Ronan
2327
topbar
2428
(?i)tooltips?
2529
url
@@ -40,6 +44,7 @@ CircleCI
4044
Clearbit
4145
Ctrl
4246
Cypress
47+
Docusaurus
4348
Django
4449
DynamoDB
4550
Elasticsearch
@@ -76,6 +81,7 @@ Mocha
7681
MongoDB
7782
MySQL
7883
Next.js
84+
nginx
7985
Node.js
8086
NodeJS
8187
npx
@@ -115,6 +121,7 @@ Webflow
115121
WebKit
116122
(?i)webpack
117123
WebStorm
124+
Windsurf's
118125
Zapier
119126

120127
# =============================================================================
@@ -123,21 +130,22 @@ Zapier
123130
agentic
124131
allowlist
125132
APIs
133+
API's
126134
args
127135
async
128-
autogenerated
129-
autogenerating
136+
autogenerat(e|ed|ing)?
130137
await
131138
bool
132139
boolean
133140
Blockquote
134141
Blockquotes
135142
cdn
136143
cli
144+
CNAME
145+
cpu
137146
config
138147
const
139148
cors
140-
CNAME
141149
csrf
142150
css
143151
ctx
@@ -171,6 +179,7 @@ lang
171179
len
172180
localhost
173181
md
182+
(?i)Memoize
174183
middleware
175184
Multiline
176185
mvc
@@ -186,6 +195,7 @@ orm
186195
params
187196
pnpm
188197
png
198+
prefill(ing|ed)?
189199
prepend
190200
prepended
191201
prev
@@ -234,8 +244,9 @@ ux
234244
val
235245
var
236246
vars
247+
waypoints
237248
webhook
238-
websocket
249+
websockets?
239250
xhr
240251
xhr2
241252
yaml

analytics/feedback.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Best practices for setting feedback statuses:
6060

6161
### Filtering by status
6262

63-
Use the status filter to control which feedback is displayed. Uncheck a status to hide all feedback with that status. By default, all feedback is displayed.
63+
Use the status filter to control which feedback is displayed. Clear a status to hide all feedback with that status. By default, all feedback is displayed.
6464

6565
### Adding internal notes
6666

authentication-personalization/overview.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ Choose from three approaches to manage access and customize your documentation b
2727

2828
**Choose partial authentication when:**
2929
- Offering public getting-started guides with private advanced features
30-
- Running a freemium product where premium users get additional documentation
3130
- Publishing open-source docs with private enterprise sections
3231

3332
**Choose personalization when:**

components/files.mdx

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: "Files"
3+
description: "Serve static assets from your documentation"
4+
icon: "folder"
5+
---
6+
7+
Mintlify automatically serves static assets from your documentation repository at the appropriate path on your domain. For example, if you have `/images/my-logo.png` in your repo, the image file is available at `https://docs.your-project.com/images/my-logo.png`.
8+
9+
This works for any file type you want to make available to your users, including images, PDFs, videos, or schemas.
10+
11+
Files must be less than 20 MB for images and 100 MB for other file types.
12+
13+
## File organization
14+
15+
Organize your files using folders to keep your repository easy to navigate:
16+
17+
```text
18+
/your-project
19+
|- docs.json
20+
|- images/
21+
|- logo.png
22+
|- screenshots/
23+
|- dashboard.png
24+
|- assets/
25+
|- whitepaper.pdf
26+
|- demo-video.mp4
27+
```
28+
29+
Files are served from the root of your domain, so the structure in your repository directly maps to the URL structure. From the previous example, `assets/whitepaper.pdf` would be available at `https://docs.your-project.com/assets/whitepaper.pdf`.

contact-support.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Visit our [YouTube](https://www.youtube.com/@GetMintlify/videos) channel for tut
1616

1717
Send us a message from your [dashboard](https://dashboard.mintlify.com/) by selecting **Support** in the sidebar.
1818

19-
![Gif showing how to access support from the dashboard by selecting the Support button, then selecting an option and typing a question in the support modal that pops up.](https://mintlify.s3.us-west-1.amazonaws.com/mintlify/images/support-flow.gif)
19+
![GIF showing how to access support from the dashboard by selecting the Support button, then selecting an option and typing a question in the support modal that pops up.](https://mintlify.s3.us-west-1.amazonaws.com/mintlify/images/support-flow.gif)
2020

2121
<Info>
2222
We aim to respond to all requests within 24 hours, but delays may occur during busy times.

guides/claude-code.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Copy this example template or make changes for your docs specifications:
3434
## Working relationship
3535
- You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
3636
- ALWAYS ask for clarification rather than making assumptions
37-
- NEVER lie, guess, or make up information
37+
- NEVER lie, guess, or make up anything
3838

3939
## Project context
4040
- Format: MDX files with YAML frontmatter
@@ -43,9 +43,9 @@ Copy this example template or make changes for your docs specifications:
4343

4444
## Content strategy
4545
- Document just enough for user success - not too much, not too little
46-
- Prioritize accuracy and usability of information
46+
- Prioritize accuracy and usability
4747
- Make content evergreen when possible
48-
- Search for existing information before adding new content. Avoid duplication unless it is done for a strategic reason
48+
- Search for existing content before adding anything new. Avoid duplication unless it is done for a strategic reason
4949
- Check existing patterns for consistency
5050
- Start by making the smallest reasonable changes
5151

guides/hidden-pages.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ If you want to hide pages for specific groups of users, use personalization to c
1616

1717
A page is hidden if it is not included in your `docs.json` navigation. To hide a page, remove it from your navigation structure.
1818

19-
Hidden pages use the same URL structure as regular pages based on their file path. For example, `guides/hidden-page.mdx` would be accessible at `docs.yoursite.com/guides/hidden-page`.
19+
Hidden pages use the same URL structure as regular pages based on their file path. For example, `guides/hidden-page.mdx` would be accessible at `docs.yoursite.com/guides/hidden-page`.
2020

2121
See an [example of a hidden page](/guides/hidden-page-example).
2222

image-embeds.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ icon: "image"
66

77
Add images, embed videos, and include interactive content with iframes to your documentation.
88

9-
All static assets in your docs repository are automatically served at the appropriate path on your domain. For example, if you have `/images/my-logo.png` in your repo, the image will be available at `https://docs.yoursite.com/images/my-logo.png`.
10-
119
<Frame>
1210
<img
1311
className="rounded-xl"

settings.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ See [Themes](themes) for more information.
197197

198198
<Expandable title="Fonts">
199199
<ResponseField name="family" type="string" required>
200-
Font family, such as "Open Sans", "Playfair Display."
200+
Font family, such as "Open Sans."
201201
</ResponseField>
202202
<ResponseField name="weight" type="number">
203203
Font weight, such as 400 or 700. Variable fonts support precise weights such as 550.
@@ -343,7 +343,7 @@ See [Themes](themes) for more information.
343343

344344
<Expandable title="Navigation">
345345
<ResponseField name="global" type="object">
346-
Global navigation elements that appear accross all pages and sections.
346+
Global navigation elements that appear across all pages and sections.
347347

348348
<Expandable title="Global">
349349
<ResponseField name="languages" type="array of object">

0 commit comments

Comments
 (0)