Skip to content

Commit e83f797

Browse files
authored
Root level core concepts (#687)
1 parent 52a6236 commit e83f797

File tree

14 files changed

+37
-37
lines changed

14 files changed

+37
-37
lines changed

core-concepts/ai-ingestion.mdx renamed to ai-ingestion.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Add **.md** to an individual docs page to see a markdown version of that page. H
4444

4545
### contextual menu
4646

47-
You can enable a [contextual menu](/core-concepts/settings#param-contextual) to allow users to copy markdown source, view markdown source, or open ChatGPT with the page content.
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.
4848

4949
### \+ c shortcut
5050

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/setup.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ and the API playground will be automatically generated from the OpenAPI document
8181
If you have multiple OpenAPI files, include the path to the OpenAPI file to ensure Mintlify finds the correct OpenAPI document. This is not required if you have
8282
only one OpenAPI file - it will automatically detect your OpenAPI file.
8383

84-
If you want to reference an external OpenAPI file using this method, provide the file’s URL in the docs.json. See [here](https://mintlify.com/docs/core-concepts/settings#param-source-4) for the correct format.
84+
If you want to reference an external OpenAPI file using this method, provide the file’s URL in the docs.json. See [here](https://mintlify.com/docssettings#param-source-4) for the correct format.
8585

8686
<CodeGroup>
8787
```md Example
@@ -133,7 +133,7 @@ npx @mintlify/scraping@latest openapi-file <path-to-openapi-file> -o api-referen
133133
Learn more about our scraping package [here](https://www.npmjs.com/package/@mintlify/scraping).
134134

135135
The scraper will output an array of
136-
[Navigation entries](/core-concepts/settings#structure) containing your OpenAPI MDX
136+
[Navigation entries](settings#structure) containing your OpenAPI MDX
137137
files. You can either append these entries to your existing Navigation, or
138138
reorder and add the files to your navigation manually.
139139

api-playground/troubleshooting.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Here's a list of common issues we've seen customers run into:
7070
requests, then all of these requests will fail. To fix this, configure your reverse proxy to
7171
allow `POST` requests to the `/api/request` path.
7272

73-
Alternatively, if your reverse proxy prevents you from accepting `POST` requests, you can configure Mintlify to send requests directly to your backend with the `api.playground.proxy` setting in the `docs.json`, as described [here](/core-concepts/settings#api-configurations). This will
73+
Alternatively, if your reverse proxy prevents you from accepting `POST` requests, you can configure Mintlify to send requests directly to your backend with the `api.playground.proxy` setting in the `docs.json`, as described [here](settings#api-configurations). This will
7474
likely require you to configure CORS on your server, as these requests will now come directly
7575
from your users' browsers.
7676
</Accordion>

changelog.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ mode: "center"
3737
<Frame>
3838
![AI Translations graphic](/images/changelog/translations.png)
3939
</Frame>
40-
Translate all of your documentation with AI. [Learn more.](/core-concepts/navigation#localization)
40+
Translate all of your documentation with AI. [Learn more.](navigation#localization)
4141

4242
## Export docs to PDF in beta
4343

4444
Export all of your documentation, a subdirectory, or a singe page as a PDF.
4545

4646
## React hook support
4747

48-
Bring interactivity to your docs. All standard React hooks are automatically available in your MDX files. [Learn more.](/core-concepts/react-components)
48+
Bring interactivity to your docs. All standard React hooks are automatically available in your MDX files. [Learn more.](react-components)
4949
</Update>
5050

5151
<Update label="March 2025">
@@ -55,7 +55,7 @@ mode: "center"
5555
![screenshot of MCP server generator](/images/changelog/mcpgenerator.png)
5656
</Frame>
5757
Generate MCP servers so that AI applications can interact with your docs or APIs. Written content is automatically generated as an MCP server, and you can generate an MCP server from your OpenAPI spec with one click.
58-
Check out [docs on getting started with MCP.](/advanced/mcp/quickstart)
58+
Check out [docs on getting started with MCP.](/mcp)
5959

6060
## Improvements
6161

@@ -110,7 +110,7 @@ mode: "center"
110110
<Frame>
111111
![graphic with text "Themes v2"](/images/changelog/themes.png)
112112
</Frame>
113-
New [pre-built themes](/core-concepts/themes) to modify the look & feel of your docs. Configure via your [docs.json file](/core-concepts/settings).
113+
New [pre-built themes](themes) to modify the look & feel of your docs. Configure via your [docs.json file](settings).
114114

115115
Now available:
116116

@@ -121,7 +121,7 @@ mode: "center"
121121
## Other improvements
122122

123123
- [Guide to Technical Writing:](https://mintlify.com/guides/introduction)Best practices for writing technical documentation, including audience research, content types, and writing tips.
124-
- [Dropdown component](/core-concepts/navigation#dropdowns): Organize navigation with a dropdown, in addition to tabs and anchors.
124+
- [Dropdown component](navigation#dropdowns): Organize navigation with a dropdown, in addition to tabs and anchors.
125125
- [AI syntax fixer](https://x.com/ricardonunez_io/status/1892334887644123192): The web editor will catch if there’s a parsing error and use AI to suggest fixes.
126126
</Update>
127127

@@ -342,7 +342,7 @@ mode: "center"
342342
`disableProxy` to disable this behavior and support request types like file
343343
uploads.
344344

345-
- [Learn more about API configurations](/core-concepts/settings#api-configurations)
345+
- [Learn more about API configurations](settings#api-configurations)
346346

347347
## Mobile SEO improvements
348348

@@ -423,7 +423,7 @@ mode: "center"
423423
- Add full-screen videos or image galleries
424424
- Embed custom iFrame demo elements to add intractability to your docs
425425

426-
Check out our [Custom Mode docs](/core-concepts/pages#custom-mode).
426+
Check out our [Custom Mode docs](pages#custom-mode).
427427
</Update>
428428

429429
<Update label="March 2024">

docs.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@
3030
{
3131
"group": "Core Concepts",
3232
"pages": [
33-
"core-concepts/settings",
34-
"core-concepts/pages",
35-
"core-concepts/navigation",
36-
"core-concepts/themes",
37-
"core-concepts/react-components",
38-
"core-concepts/ai-ingestion"
33+
"settings",
34+
"pages",
35+
"navigation",
36+
"themes",
37+
"react-components",
38+
"ai-ingestion"
3939
]
4040
},
4141
{
@@ -111,7 +111,7 @@
111111
"settings/gitlab",
112112
"settings/ci",
113113
"settings/preview-deployments",
114-
"core-concepts/custom-scripts",
114+
"settings/custom-scripts",
115115
"mcp",
116116
{
117117
"group": "Integrations",

core-concepts/navigation.mdx renamed to navigation.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Structure and customize your documentation's navigation hierarchy"
44
icon: "map"
55
---
66

7-
The [navigation](/core-concepts/settings#param-navigation) property in [docs.json](/core-concepts/settings) defines how users will browse through your documentation. Think of it as the blueprint for your documentation's menu structure.
7+
The [navigation](settings#param-navigation) property in [docs.json](settings) defines how users will browse through your documentation. Think of it as the blueprint for your documentation's menu structure.
88

99
With proper navigation configuration, you can organize your content into a logical hierarchy that makes it easy for users to find exactly what they're looking for.
1010

@@ -15,7 +15,7 @@ Pages are the most fundamental navigation component.
1515
<img className="block dark:hidden pointer-events-none" src="/images/navigation/pages-light.png" />
1616
<img className="hidden dark:block pointer-events-none" src="/images/navigation/pages-dark.png" />
1717

18-
Pages is an array where each entry must be a reference to the path of a [page file](/core-concepts/pages).
18+
Pages is an array where each entry must be a reference to the path of a [page file](pages).
1919

2020
```json
2121
{

core-concepts/pages.mdx renamed to pages.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ icon: "code"
4848
---
4949
```
5050

51-
You can set icons from [Font Awesome](https://fontawesome.com/icons) and [Lucide](https://lucide.dev/icons), depending on the [icon library setting](/core-concepts/settings#param-icons).
51+
You can set icons from [Font Awesome](https://fontawesome.com/icons) and [Lucide](https://lucide.dev/icons), depending on the [icon library setting](settings#param-icons).
5252

5353
You can also set the icon type for Font Awesome icons (optional). If not set, the icon type will be regular.
5454

quickstart.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,10 +208,10 @@ Enter your domain (e.g., docs.yourcompany.com) and follow the provided instructi
208208

209209
Congratulations! You've successfully deployed your documentation site with Mintlify. Here are some suggested next steps to enhance your documentation:
210210

211-
<Card title="Customize Your Theme" icon="paintbrush" href="/core-concepts/themes" horizontal>
211+
<Card title="Customize Your Theme" icon="paintbrush" href="themes" horizontal>
212212
Learn how to customize colors, fonts, and the overall appearance of your documentation site.
213213
</Card>
214-
<Card title="Organize Navigation" icon="map" href="/core-concepts/navigation#overview" horizontal>
214+
<Card title="Organize Navigation" icon="map" href="navigation#overview" horizontal>
215215
Structure your documentation with intuitive navigation to help users find what they need.
216216
</Card>
217217
<Card title="Add Interactive Components" icon="puzzle" href="/components/accordions" horizontal>
File renamed without changes.

0 commit comments

Comments
 (0)