diff --git a/core-concepts/ai-ingestion.mdx b/ai-ingestion.mdx similarity index 91% rename from core-concepts/ai-ingestion.mdx rename to ai-ingestion.mdx index ed40c9566..d48fa0492 100644 --- a/core-concepts/ai-ingestion.mdx +++ b/ai-ingestion.mdx @@ -44,7 +44,7 @@ Add **.md** to an individual docs page to see a markdown version of that page. H ### contextual menu -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. +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. ### ⌘ \+ c shortcut diff --git a/api-playground/mdx/configuration.mdx b/api-playground/mdx/configuration.mdx index 02b3c7b03..d0036296f 100644 --- a/api-playground/mdx/configuration.mdx +++ b/api-playground/mdx/configuration.mdx @@ -31,7 +31,7 @@ Mintlify allows you to define your API endpoints using a combination of `docs.js } ``` - Find a full list of API configurations [here](/core-concepts/settings#param-api). + Find a full list of API configurations [here](settings#param-api). @@ -53,7 +53,7 @@ Mintlify allows you to define your API endpoints using a combination of `docs.js - If you have `server` configured in [docs.json](/core-concepts/settings), you can use relative paths like `/v1/endpoint`. + If you have `server` configured in [docs.json](settings), you can use relative paths like `/v1/endpoint`. @@ -69,6 +69,6 @@ Mintlify allows you to define your API endpoints using a combination of `docs.js - 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). + 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). diff --git a/api-playground/openapi/setup.mdx b/api-playground/openapi/setup.mdx index 451e5f3bd..9b483cadb 100644 --- a/api-playground/openapi/setup.mdx +++ b/api-playground/openapi/setup.mdx @@ -81,7 +81,7 @@ and the API playground will be automatically generated from the OpenAPI document 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 only one OpenAPI file - it will automatically detect your OpenAPI file. -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. +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. ```md Example @@ -133,7 +133,7 @@ npx @mintlify/scraping@latest openapi-file -o api-referen Learn more about our scraping package [here](https://www.npmjs.com/package/@mintlify/scraping). The scraper will output an array of -[Navigation entries](/core-concepts/settings#structure) containing your OpenAPI MDX +[Navigation entries](settings#structure) containing your OpenAPI MDX files. You can either append these entries to your existing Navigation, or reorder and add the files to your navigation manually. diff --git a/api-playground/troubleshooting.mdx b/api-playground/troubleshooting.mdx index 078d23fa9..5ea89fd88 100644 --- a/api-playground/troubleshooting.mdx +++ b/api-playground/troubleshooting.mdx @@ -70,7 +70,7 @@ Here's a list of common issues we've seen customers run into: requests, then all of these requests will fail. To fix this, configure your reverse proxy to allow `POST` requests to the `/api/request` path. - 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 + 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 likely require you to configure CORS on your server, as these requests will now come directly from your users' browsers. diff --git a/changelog.mdx b/changelog.mdx index a5c3e5ed3..13bdf361b 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -37,7 +37,7 @@ mode: "center" ![AI Translations graphic](/images/changelog/translations.png) - Translate all of your documentation with AI. [Learn more.](/core-concepts/navigation#localization) + Translate all of your documentation with AI. [Learn more.](navigation#localization) ## Export docs to PDF in beta @@ -45,7 +45,7 @@ mode: "center" ## React hook support - Bring interactivity to your docs. All standard React hooks are automatically available in your MDX files. [Learn more.](/core-concepts/react-components) + Bring interactivity to your docs. All standard React hooks are automatically available in your MDX files. [Learn more.](react-components) @@ -55,7 +55,7 @@ mode: "center" ![screenshot of MCP server generator](/images/changelog/mcpgenerator.png) 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. - Check out [docs on getting started with MCP.](/advanced/mcp/quickstart) + Check out [docs on getting started with MCP.](/mcp) ## Improvements @@ -110,7 +110,7 @@ mode: "center" ![graphic with text "Themes v2"](/images/changelog/themes.png) - New [pre-built themes](/core-concepts/themes) to modify the look & feel of your docs. Configure via your [docs.json file](/core-concepts/settings). + New [pre-built themes](themes) to modify the look & feel of your docs. Configure via your [docs.json file](settings). Now available: @@ -121,7 +121,7 @@ mode: "center" ## Other improvements - [Guide to Technical Writing:](https://mintlify.com/guides/introduction)Best practices for writing technical documentation, including audience research, content types, and writing tips. - - [Dropdown component](/core-concepts/navigation#dropdowns): Organize navigation with a dropdown, in addition to tabs and anchors. + - [Dropdown component](navigation#dropdowns): Organize navigation with a dropdown, in addition to tabs and anchors. - [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. @@ -342,7 +342,7 @@ mode: "center" `disableProxy` to disable this behavior and support request types like file uploads. - - [Learn more about API configurations](/core-concepts/settings#api-configurations) + - [Learn more about API configurations](settings#api-configurations) ## Mobile SEO improvements @@ -423,7 +423,7 @@ mode: "center" - Add full-screen videos or image galleries - Embed custom iFrame demo elements to add intractability to your docs - Check out our [Custom Mode docs](/core-concepts/pages#custom-mode). + Check out our [Custom Mode docs](pages#custom-mode). diff --git a/docs.json b/docs.json index 500f25411..848febe4a 100644 --- a/docs.json +++ b/docs.json @@ -30,12 +30,12 @@ { "group": "Core Concepts", "pages": [ - "core-concepts/settings", - "core-concepts/pages", - "core-concepts/navigation", - "core-concepts/themes", - "core-concepts/react-components", - "core-concepts/ai-ingestion" + "settings", + "pages", + "navigation", + "themes", + "react-components", + "ai-ingestion" ] }, { @@ -111,7 +111,7 @@ "settings/gitlab", "settings/ci", "settings/preview-deployments", - "core-concepts/custom-scripts", + "settings/custom-scripts", "mcp", { "group": "Integrations", diff --git a/core-concepts/navigation.mdx b/navigation.mdx similarity index 97% rename from core-concepts/navigation.mdx rename to navigation.mdx index a09ef050b..2f394e0da 100644 --- a/core-concepts/navigation.mdx +++ b/navigation.mdx @@ -4,7 +4,7 @@ description: "Structure and customize your documentation's navigation hierarchy" icon: "map" --- -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. +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. 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. @@ -15,7 +15,7 @@ Pages are the most fundamental navigation component. -Pages is an array where each entry must be a reference to the path of a [page file](/core-concepts/pages). +Pages is an array where each entry must be a reference to the path of a [page file](pages). ```json { diff --git a/core-concepts/pages.mdx b/pages.mdx similarity index 98% rename from core-concepts/pages.mdx rename to pages.mdx index 17a8fcec8..e28e720f9 100644 --- a/core-concepts/pages.mdx +++ b/pages.mdx @@ -48,7 +48,7 @@ icon: "code" --- ``` -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). +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). You can also set the icon type for Font Awesome icons (optional). If not set, the icon type will be regular. diff --git a/quickstart.mdx b/quickstart.mdx index f7f2a5f53..7e5c99bd2 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -208,10 +208,10 @@ Enter your domain (e.g., docs.yourcompany.com) and follow the provided instructi Congratulations! You've successfully deployed your documentation site with Mintlify. Here are some suggested next steps to enhance your documentation: - + Learn how to customize colors, fonts, and the overall appearance of your documentation site. - + Structure your documentation with intuitive navigation to help users find what they need. diff --git a/core-concepts/react-components.mdx b/react-components.mdx similarity index 100% rename from core-concepts/react-components.mdx rename to react-components.mdx diff --git a/core-concepts/settings.mdx b/settings.mdx similarity index 97% rename from core-concepts/settings.mdx rename to settings.mdx index 3ffec69aa..651560532 100644 --- a/core-concepts/settings.mdx +++ b/settings.mdx @@ -21,7 +21,7 @@ This section contains the full reference for the docs.json file. One of the following: `mint`, `maple`, `palm`, `willow`, `linden`, `almond`. - The layout theme of the project. Check out the [Themes](/core-concepts/themes) page for more information. + The layout theme of the project. Check out the [Themes](themes) page for more information. @@ -369,32 +369,32 @@ This section contains the full reference for the docs.json file. - Organizing by [languages](/core-concepts/navigation#localization) + Organizing by [languages](navigation#localization) - Organizing by [versions](/core-concepts/navigation#versions) + Organizing by [versions](navigation#versions) - Organizing by [tabs](/core-concepts/navigation#divisions#tabs) + Organizing by [tabs](navigation#divisions#tabs) - Organizing by [anchors](/core-concepts/navigation#divisions#anchors) + Organizing by [anchors](navigation#divisions#anchors) - Organizing by [dropdowns](/core-concepts/navigation#divisions#dropdowns) + Organizing by [dropdowns](navigation#divisions#dropdowns) - Organizing by [groups](/core-concepts/navigation#pages#pages) + Organizing by [groups](navigation#pages#pages) - An array of [page paths or groups](/core-concepts/navigation#pages#groups) + An array of [page paths or groups](navigation#pages#groups) diff --git a/core-concepts/custom-scripts.mdx b/settings/custom-scripts.mdx similarity index 100% rename from core-concepts/custom-scripts.mdx rename to settings/custom-scripts.mdx diff --git a/settings/seo.mdx b/settings/seo.mdx index 53a0f8dca..7c7a487ba 100644 --- a/settings/seo.mdx +++ b/settings/seo.mdx @@ -6,7 +6,7 @@ icon: 'search' The platform automatically generates most meta tags. -However, you can fully customize them by adding the [metadata](/core-concepts/settings#param-metadata) field to your `docs.json` or the page's frontmatter. +However, you can fully customize them by adding the [metadata](settings#param-metadata) field to your `docs.json` or the page's frontmatter. @@ -51,7 +51,7 @@ Only pages included in your `docs.json` are included by default. To include hidd ## Disabling indexing -If you want to stop a page from being indexed by search engines, you can include the following in the [frontmatter](/core-concepts/pages) of your page: +If you want to stop a page from being indexed by search engines, you can include the following in the [frontmatter](pages) of your page: ``` --- diff --git a/core-concepts/themes.mdx b/themes.mdx similarity index 96% rename from core-concepts/themes.mdx rename to themes.mdx index 9252974e2..a6d35f3c2 100644 --- a/core-concepts/themes.mdx +++ b/themes.mdx @@ -34,7 +34,7 @@ export const ThemeCard = ({ title, value, description, href }) => {

Themes

- +