Skip to content

Commit 817e220

Browse files
committed
Merge branch 'main' into new-support-page
2 parents c3b4610 + 32f021e commit 817e220

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+991
-759
lines changed

.github/workflows/check-links.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ jobs:
1313
with:
1414
node-version: "latest"
1515
- name: Install Mintlify CLI
16-
run: npm i -g mintlify
16+
run: npm i -g mint
1717
- name: Run broken link checker
18-
run: mintlify broken-links
18+
run: mint broken-links

advanced/dashboard/roles.mdx

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: "Roles"
3+
description: "Control access to your dashboard with roles."
4+
---
5+
6+
Mintlify provides two dashboard access levels: Editor and Admin.
7+
8+
The following describes actions that are limited to the Admin role:
9+
10+
| | Editor | Admin |
11+
| ----------------------- | :----: | :---: |
12+
| Update user roles |||
13+
| Delete users |||
14+
| Invite admin users |||
15+
| Manage & update billing |||
16+
| Update custom domain |||
17+
| Update Git source |||
18+
| Delete org |||
19+
20+
Other actions on the dashboard are available to both roles.
21+
22+
You can invite as many admins as you want, but we recommend limiting admin
23+
access to users who need it.

advanced/mcp/generate.mdx

Lines changed: 0 additions & 39 deletions
This file was deleted.

advanced/mcp/quickstart.mdx

Lines changed: 0 additions & 95 deletions
This file was deleted.

ai-ingestion.mdx

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: "AI Ingestion"
3+
description: "Learn how to feed your documentation into LLMs and AI tools"
4+
icon: "bot-message-square"
5+
---
6+
7+
export const PreviewButton = ({ children, href }) => {
8+
return (
9+
<a href={href} className="text-sm font-medium text-white dark:!text-zinc-950 bg-zinc-900 hover:bg-zinc-700 dark:bg-zinc-100 hover:dark:bg-zinc-300 rounded-full px-3.5 py-1.5 not-prose">
10+
{children}
11+
</a>
12+
)
13+
}
14+
15+
Documentation pages are content rich and can be a great source of information for LLMs for AI tools.
16+
17+
Today, you can use your documentation to fine-tune a chatbot, answer questions about your product, or use it to generate code.
18+
19+
## Supported Shortcuts
20+
21+
We support a variety of shortcuts and configurations to make it easier to use your documentation in AI tools.
22+
23+
### /llms.txt
24+
25+
An [industry standard](https://llmstxt.org) that helps general-purpose LLMs index more efficiently (e.g. a sitemap for AI).
26+
27+
Every documentation site automatically hosts a **/llms.txt** file at the root that lists all available pages in your documentation.
28+
29+
<PreviewButton href="https://mintlify.com/docs/llms.txt">Open llms.txt for this site</PreviewButton>
30+
31+
### /llms-full.txt
32+
33+
A markdown file of all your content is automatically available at **/llms-full.txt**.
34+
35+
llms-full.txt contains the entire content of your docs, and is a great way to provide a complete context to AI tools.
36+
37+
<PreviewButton href="https://mintlify.com/docs/llms-full.txt">Open llms-full.txt for this site</PreviewButton>
38+
39+
### .md extension
40+
41+
Add **.md** to an individual docs page to see a markdown version of that page. Helps load individual pages into AI tools with better token efficiency & inference time.
42+
43+
<PreviewButton href="https://mintlify.com/docs/quickstart.md">Open quickstart.md</PreviewButton>
44+
45+
### contextual menu
46+
47+
You can enable a [contextual menu](settings#param-contextual) to allow users to copy markdown source, view markdown source, or open ChatGPT with the page content.
48+
49+
### \+ c shortcut
50+
51+
Copy markdown source of any page using command \+ c.

api-playground/mdx/configuration.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Mintlify allows you to define your API endpoints using a combination of `docs.js
3131
}
3232
```
3333

34-
Find a full list of API configurations [here](/core-concepts/settings#param-api).
34+
Find a full list of API configurations [here](settings#param-api).
3535
</Step>
3636

3737
<Step title="Create your endpoint pages">
@@ -53,7 +53,7 @@ Mintlify allows you to define your API endpoints using a combination of `docs.js
5353

5454
<Note>
5555

56-
If you have `server` configured in [docs.json](/core-concepts/settings), you can use relative paths like `/v1/endpoint`.
56+
If you have `server` configured in [docs.json](settings), you can use relative paths like `/v1/endpoint`.
5757

5858
</Note>
5959

@@ -69,6 +69,6 @@ Mintlify allows you to define your API endpoints using a combination of `docs.js
6969
</Step>
7070

7171
<Step title="Add your endpoints to your docs">
72-
Add your endpoint pages to the sidebar by adding the paths to the `navigation` field in your `docs.json`. Learn more about structuring your docs [here](/core-concepts/navigation).
72+
Add your endpoint pages to the sidebar by adding the paths to the `navigation` field in your `docs.json`. Learn more about structuring your docs [here](navigation).
7373
</Step>
7474
</Steps>

api-playground/openapi/advanced-features.mdx

Lines changed: 34 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -136,40 +136,61 @@ paths:
136136
planter.list({ potted: true });
137137
```
138138

139-
## `x-hidden`
139+
## `x-hidden` and `x-excluded`
140140

141-
If your pages are [autogenerated](/api-playground/openapi/setup) from an OpenAPI document, but there are some paths that you don't want to create pages for, you can hide them by adding the property `x-hidden`.
141+
If your pages are [autogenerated](/api-playground/openapi/setup) from an OpenAPI document, but there are some paths that you don't want to create pages for, you can exclude them from having pages generated by adding the property `x-excluded`.
142142

143-
You can add the `x-hidden` tag under endpoint or webhook paths below the method.
143+
If you want to have pages generated, but not have them appear in the navigation, add `x-hidden`.
144+
145+
You can add the `x-hidden` or `x-excluded` tag under endpoint or webhook paths below the method.
144146

145147
Here's are examples of how that would look in an OpenAPI schema document for an endpoint or a webhook path:
146148

147-
```json {14}
149+
```json {11, 19}
148150
"paths": {
149151
"/plants": {
150152
"get": {
151153
"description": "Returns all plants from the store",
152154
"parameters": { ... },
153-
"responses": { ... },
155+
"responses": { ... }
154156
}
155-
}
157+
},
158+
"/hidden_plants": {
159+
"get": {
160+
"x-hidden": true,
161+
"description": "Returns all somewhat secret plants from the store",
162+
"parameters": { ... },
163+
"responses": { ... }
164+
}
165+
},
156166
"/secret_plants": {
157167
"get": {
158-
"description": "Returns all secret plants from the store (do not publish this endpoint!)",
168+
"x-excluded": true,
169+
"description": "Returns all top secret plants from the store (do not publish this endpoint!)",
159170
"parameters": { ... },
160-
"responses": { ... },
161-
"x-hidden": true
171+
"responses": { ... }
162172
}
163173
}
164174
},
165175
```
166176

167-
```json {5}
177+
```json {9, 15}
168178
"webhooks": {
169-
"/secret_pants_hook": {
179+
"/plants_hook": {
180+
"post": {
181+
"description": "Webhook for information about a new plant added to the store",
182+
}
183+
},
184+
"/hidden_plants_hook": {
185+
"post": {
186+
"x-hidden": true,
187+
"description": "Webhook for somewhat secret information about a new plant added to the store"
188+
}
189+
},
190+
"/secret_plants_hook": {
170191
"post": {
171-
"description": "Secret webhook for information about a new plant added to the store",
172-
"x-hidden": true
192+
"x-excluded": true,
193+
"description": "Webhook for top secret information about a new plant added to the store (do not publish this endpoint!)"
173194
}
174195
}
175196
}

0 commit comments

Comments
 (0)