From 33f45326d886f206dc08fbd7e71667ae6c027031 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 19 Sep 2025 13:24:16 -0700 Subject: [PATCH 01/43] implement task-based IA --- docs.json | 1030 +++++++++++++++++++++++++++-------------------------- 1 file changed, 519 insertions(+), 511 deletions(-) diff --git a/docs.json b/docs.json index 6d1555857..c1b2eae34 100644 --- a/docs.json +++ b/docs.json @@ -3,553 +3,561 @@ "theme": "maple", "name": "Mintlify", "colors": { - "primary": "#0D9373", - "light": "#55D799", - "dark": "#0D9373" + "primary": "#0D9373", + "light": "#55D799", + "dark": "#0D9373" }, "favicon": "/favicon.ico", "icons": { - "library": "lucide" + "library": "lucide" }, "navigation": { - "tabs": [ - { - "tab": "Documentation", - "groups": [ - { - "group": "Getting started", - "pages": [ - "index", - "quickstart", - "installation", - { - "group": "Web editor", - "icon": "mouse-pointer-2", - "pages": [ - "editor/getting-started", - "editor/git-concepts", - "editor/branches", - "editor/content-management", - "editor/publishing", - "editor/keyboard-shortcuts", - "editor/troubleshooting" - ] - } - ] - }, - { - "group": "Core configuration", - "pages": [ - "settings", - "pages", - "navigation", - "themes", - "settings/custom-domain" - ] - }, - { - "group": "AI optimization", - "pages": [ - "guides/assistant", - "ai/llmstxt", - "ai/contextual-menu", - "ai/model-context-protocol", - "ai/markdown-export", - "guides/geo", - "guides/claude-code", - "guides/cursor", - "guides/windsurf", - "ai/slack-app" - ] - }, - { - "group": "Components", - "pages": [ - "text", - "image-embeds", - "list-table", - "code", - "reusable-snippets", - "components/accordions", - "components/callouts", - "components/cards", - "components/columns", - "components/code-groups", - "components/examples", - "components/expandables", - "components/fields", - "components/frames", - "components/icons", - "components/mermaid-diagrams", - "components/panel", - "components/steps", - "components/tabs", - "components/tooltips", - "components/update", - "components/banner" - ] - }, + "tabs": [ { - "group": "API pages", - "pages": [ - "api-playground/overview", - "api-playground/openapi-setup", - "api-playground/migrating-from-mdx", - { - "group": "Customization", - "icon": "wrench", - "pages": [ - "api-playground/customization/complex-data-types", - "api-playground/customization/adding-sdk-examples", - "api-playground/customization/managing-page-visibility", - "api-playground/customization/multiple-responses" - ] - }, - { - "group": "AsyncAPI", - "icon": "webhook", - "pages": [ - "api-playground/asyncapi/setup", - "api-playground/asyncapi/playground" - ] - }, - { - "group": "MDX", - "icon": "markdown", - "pages": [ - "api-playground/mdx/configuration", - "api-playground/mdx/authentication" - ] - }, - "api-playground/troubleshooting" - ] + "tab": "Documentation", + "groups": [ + { + "group": "Get started", + "pages": [ + "index", + "quickstart", + "installation", + { + "group": "Visual editor", + "icon": "mouse-pointer-2", + "pages": [ + "editor/getting-started", + "editor/git-concepts", + "editor/branches", + "editor/content-management", + "editor/publishing", + "editor/keyboard-shortcuts", + "editor/troubleshooting" + ] + }, + "guides/migration" + ] + }, + { + "group": "Customize", + "pages": [ + "themes", + "settings/custom-domain", + "settings/custom-scripts", + "react-components", + "settings/custom-404-page", + { + "group": "Dashboard access", + "icon": "gauge", + "pages": [ + "advanced/dashboard/sso", + "advanced/dashboard/permissions", + "advanced/dashboard/roles" + ] + } + ] + }, + { + "group": "Organize", + "pages": [ + "pages", + "navigation", + "settings" + ] + }, + { + "group": "Write and edit", + "pages": [ + "text", + "code", + "image-embeds", + "list-table", + { + "group": "Components", + "icon": "blocks", + "pages": [ + "text", + "image-embeds", + "list-table", + "code", + "reusable-snippets", + "components/accordions", + "components/banner", + "components/callouts", + "components/cards", + "components/code-groups", + "components/columns", + "components/examples", + "components/expandables", + "components/fields", + "components/frames", + "components/icons", + "components/mermaid-diagrams", + "components/panel", + "components/responses", + "components/steps", + "components/tabs", + "components/tooltips", + "components/update" + ] + }, + "reusable-snippets", + "settings/broken-links", + { + "group": "API playground", + "icon": "play", + "pages": [ + "api-playground/overview", + "api-playground/openapi-setup", + "api-playground/migrating-from-mdx", + { + "group": "Customization", + "pages": [ + "api-playground/customization/complex-data-types", + "api-playground/customization/adding-sdk-examples", + "api-playground/customization/managing-page-visibility", + "api-playground/customization/multiple-responses" + ] + }, + { + "group": "MDX", + "pages": [ + "api-playground/mdx/configuration", + "api-playground/mdx/authentication" + ] + }, + { + "group": "AsyncAPI", + "pages": [ + "api-playground/asyncapi/setup", + "api-playground/asyncapi/playground" + ] + }, + "api-playground/troubleshooting" + ] + }, + "guides/changelogs" + ] + }, + { + "group": "Publish", + "pages": [ + "guides/deployments", + "settings/preview-deployments", + "guides/hidden-pages", + { + "group": "Custom subdirectory", + "icon": "folder", + "pages": [ + "advanced/subpath/cloudflare", + "advanced/subpath/route53-cloudfront", + "advanced/subpath/vercel", + "guides/reverse-proxy", + "guides/csp-configuration" + ] + }, + "guides/monorepo", + "authentication-personalization/authentication-setup", + "authentication-personalization/personalization-setup", + "settings/ci", + "settings/github", + "settings/gitlab" + ] + }, + { + "group": "Optimize", + "pages": [ + { + "group": "AI", + "icon": "bot", + "pages": [ + "guides/assistant", + "ai/llmstxt", + "ai/contextual-menu", + "ai/model-context-protocol", + "ai/markdown-export", + "guides/geo", + "ai/slack-app" + ] + }, + { + "group": "Analytics", + "icon": "chart-line", + "pages": [ + "analytics/overview", + "analytics/feedback", + "analytics/search", + "analytics/improving-docs" + ] + }, + "settings/seo", + { + "group": "Integrations", + "icon": "folder-code", + "pages": [ + "guides/claude-code", + "guides/cursor", + "guides/windsurf", + { + "group": "Analytics", + "pages": [ + "integrations/analytics/overview", + "integrations/analytics/amplitude", + "integrations/analytics/clearbit", + "integrations/analytics/fathom", + "integrations/analytics/google-analytics", + "integrations/analytics/google-tag-manager", + "integrations/analytics/heap", + "integrations/analytics/hightouch", + "integrations/analytics/hotjar", + "integrations/analytics/koala", + "integrations/analytics/logrocket", + "integrations/analytics/mixpanel", + "integrations/analytics/pirsch", + "integrations/analytics/plausible", + "integrations/analytics/posthog", + "integrations/analytics/segment" + ] + }, + { + "group": "SDKs", + "pages": [ + "integrations/sdks/speakeasy", + "integrations/sdks/stainless" + ] + }, + { + "group": "Support", + "pages": [ + "integrations/support/overview", + "integrations/support/intercom", + "integrations/support/front" + ] + }, + { + "group": "Privacy", + "pages": [ + "integrations/privacy/overview", + "integrations/privacy/osano" + ] + } + ] + }, + "contact-support" + ] + } + ] }, { - "group": "Authentication and personalization", - "pages": [ - "authentication-personalization/authentication-setup", - "authentication-personalization/personalization-setup" - ] + "tab": "API Reference", + "groups": [ + { + "group": "API Reference", + "pages": [ + "api-reference/introduction" + ] + }, + { + "group": "Admin", + "pages": [ + "api-reference/update/trigger", + "api-reference/update/status" + ] + }, + { + "group": "Assistant", + "pages": [ + "api-reference/assistant/create-assistant-message", + "api-reference/assistant/search" + ] + } + ] }, { - "group": "Guides", - "pages": [ - "guides/migration", - { - "group": "Analytics dashboard", - "icon": "chart-line", - "pages": [ - "analytics/overview", - "analytics/feedback", - "analytics/search", - "analytics/improving-docs" - ] - }, - "react-components", - "settings/custom-scripts", - "settings/seo", - "guides/changelogs", - "guides/hidden-pages", - "settings/broken-links", - "settings/custom-404-page", - "guides/monorepo", - { - "group": "Custom subdirectory", - "icon": "folder", - "pages": [ - "advanced/subpath/cloudflare", - "advanced/subpath/route53-cloudfront", - "advanced/subpath/vercel", - "guides/reverse-proxy", - "guides/csp-configuration" - ] - }, - { - "group": "Dashboard access", - "icon": "gauge", - "pages": [ - "advanced/dashboard/sso", - "advanced/dashboard/permissions", - "advanced/dashboard/roles" - ] - }, - "guides/deployments", - "contact-support" - ] - }, - { - "group": "Integrations", - "pages": [ - { - "group": "Analytics", - "icon": "chart-no-axes-combined", - "pages": [ - "integrations/analytics/overview", - "integrations/analytics/amplitude", - "integrations/analytics/clearbit", - "integrations/analytics/fathom", - "integrations/analytics/google-analytics", - "integrations/analytics/google-tag-manager", - "integrations/analytics/heap", - "integrations/analytics/hightouch", - "integrations/analytics/hotjar", - "integrations/analytics/koala", - "integrations/analytics/logrocket", - "integrations/analytics/mixpanel", - "integrations/analytics/pirsch", - "integrations/analytics/plausible", - "integrations/analytics/posthog", - "integrations/analytics/segment" - ] - }, - { - "group": "SDKs", - "icon": "folder-code", - "pages": [ - "integrations/sdks/speakeasy", - "integrations/sdks/stainless" - ] - }, - { - "group": "Support", - "icon": "messages-square", - "pages": [ - "integrations/support/overview", - "integrations/support/intercom", - "integrations/support/front" - ] - }, - { - "group": "Privacy", - "icon": "folder-lock", - "pages": [ - "integrations/privacy/overview", - "integrations/privacy/osano" - ] - } - ] - }, - { - "group": "Version control and CI/CD", - "pages": [ - "settings/github", - "settings/gitlab", - "settings/ci", - "settings/preview-deployments" - ] + "tab": "Changelog", + "groups": [ + { + "group": "Changelog", + "pages": [ + "changelog" + ] + } + ] } - ] - }, - { - "tab": "API Reference", - "groups": [ - { - "group": "API Reference", - "pages": [ - "api-reference/introduction" - ] - }, - { - "group": "Admin", - "pages": [ - "api-reference/update/trigger", - "api-reference/update/status" - ] - }, - { - "group": "Assistant", - "pages": [ - "api-reference/assistant/create-assistant-message", - "api-reference/assistant/search" - ] - } - ] - }, - { - "tab": "Changelog", - "groups": [ - { - "group": "Changelog", - "pages": [ - "changelog" - ] - } - ] - } - ] + ] }, "logo": { - "light": "/logo/light.svg", - "dark": "/logo/dark.svg", - "href": "https://mintlify.com/docs" + "light": "/logo/light.svg", + "dark": "/logo/dark.svg", + "href": "https://mintlify.com/docs" }, "api": { - "mdx": { - "auth": { - "method": "bearer" + "mdx": { + "auth": { + "method": "bearer" + } } - } }, "navbar": { - "primary": { - "type": "button", - "label": "Get started", - "href": "https://mintlify.com/start" - } + "primary": { + "type": "button", + "label": "Get started", + "href": "https://mintlify.com/start" + } }, "footer": { - "socials": { - "x": "https://x.com/mintlify", - "linkedin": "https://www.linkedin.com/company/mintlify", - "github": "https://github.com/mintlify" - }, - "links": [ - { - "header": "Explore", - "items": [ - { - "label": "Startups", - "href": "https://www.mintlify.com/startups" - }, - { - "label": "Enterprise", - "href": "https://www.mintlify.com/enterprise" - }, - { - "label": "Switch", - "href": "https://www.mintlify.com/switch" - } - ] - }, - { - "header": "Resources", - "items": [ - { - "label": "Customers", - "href": "https://mintlify.com/customers" - }, - { - "label": "Blog", - "href": "https://mintlify.com/blog" - }, - { - "label": "Pricing", - "href": "https://www.mintlify.com/pricing" - }, - { - "label": "Guides", - "href": "https://www.mintlify.com/guides" - }, - { - "label": "Feature Requests", - "href": "https://github.com/orgs/mintlify/discussions/categories/feature-requests" - } - ] + "socials": { + "x": "https://x.com/mintlify", + "linkedin": "https://www.linkedin.com/company/mintlify", + "github": "https://github.com/mintlify" }, - { - "header": "Company", - "items": [ + "links": [ { - "label": "Careers", - "href": "https://mintlify.com/careers" + "header": "Explore", + "items": [ + { + "label": "Startups", + "href": "https://www.mintlify.com/startups" + }, + { + "label": "Enterprise", + "href": "https://www.mintlify.com/enterprise" + }, + { + "label": "Switch", + "href": "https://www.mintlify.com/switch" + } + ] }, { - "label": "Wall of Love", - "href": "https://www.mintlify.com/wall-of-love" - } - ] - }, - { - "header": "Legal", - "items": [ - { - "label": "Privacy Policy", - "href": "https://mintlify.com/legal/privacy" + "header": "Resources", + "items": [ + { + "label": "Customers", + "href": "https://mintlify.com/customers" + }, + { + "label": "Blog", + "href": "https://mintlify.com/blog" + }, + { + "label": "Pricing", + "href": "https://www.mintlify.com/pricing" + }, + { + "label": "Guides", + "href": "https://www.mintlify.com/guides" + }, + { + "label": "Feature Requests", + "href": "https://github.com/orgs/mintlify/discussions/categories/feature-requests" + } + ] }, { - "label": "Terms of Service", - "href": "https://mintlify.com/legal/terms" + "header": "Company", + "items": [ + { + "label": "Careers", + "href": "https://mintlify.com/careers" + }, + { + "label": "Wall of Love", + "href": "https://www.mintlify.com/wall-of-love" + } + ] }, { - "label": "Security", - "href": "https://security.mintlify.com/?_gl=1*ascm4x*_gcl_au*NTU1ODkzNjQ0LjE3NTQ5Mjg4NzIuMTgzMDQ5NTExMS4xNzU3NTQwMDk1LjE3NTc1NDAwOTQ." + "header": "Legal", + "items": [ + { + "label": "Privacy Policy", + "href": "https://mintlify.com/legal/privacy" + }, + { + "label": "Terms of Service", + "href": "https://mintlify.com/legal/terms" + }, + { + "label": "Security", + "href": "https://security.mintlify.com/?_gl=1*ascm4x*_gcl_au*NTU1ODkzNjQ0LjE3NTQ5Mjg4NzIuMTgzMDQ5NTExMS4xNzU3NTQwMDk1LjE3NTc1NDAwOTQ." + } + ] } - ] - } - ] + ] }, "thumbnails": { - "background": "/images/thumbnail/background.svg" + "background": "/images/thumbnail/background.svg" }, "contextual": { - "options": [ - "copy", - "chatgpt", - "claude", - "cursor", - "vscode" - ] + "options": [ + "copy", + "chatgpt", + "claude", + "cursor", + "vscode" + ] }, "redirects": [ - { - "source": "/content/components/accordions", - "destination": "/components/accordions" - }, - { - "source": "/content/components/callouts", - "destination": "/components/callouts" - }, - { - "source": "/content/components/cards", - "destination": "/components/cards" - }, - { - "source": "/content/components/card-groups", - "destination": "/components/columns" - }, - { - "source": "/content/components/code-groups", - "destination": "/components/code-groups" - }, - { - "source": "/content/components/examples", - "destination": "/components/examples" - }, - { - "source": "/content/components/expandables", - "destination": "/components/expandables" - }, - { - "source": "/content/components/fields", - "destination": "/components/fields" - }, - { - "source": "/content/components/frames", - "destination": "/components/frames" - }, - { - "source": "/content/components/icons", - "destination": "/components/icons" - }, - { - "source": "/content/components/mermaid-diagrams", - "destination": "/components/mermaid-diagrams" - }, - { - "source": "/content/components/steps", - "destination": "/components/steps" - }, - { - "source": "/content/components/tabs", - "destination": "/components/tabs" - }, - { - "source": "/content/components/tooltips", - "destination": "/components/tooltips" - }, - { - "source": "/content/components/update", - "destination": "/components/update" - }, - { - "source": "/api-playground/openapi/advanced-features", - "destination": "/api-playground/customization" - }, - { - "source": "/api-playground/openapi/setup", - "destination": "/api-playground/openapi-setup" - }, - { - "source": "/api-playground/openapi/writing-openapi", - "destination": "/api-playground/openapi-setup" - }, - { - "source": "settings/authentication-personalization/authentication-vs-personalization", - "destination": "authentication-personalization/overview" - }, - { - "source": "settings/authentication-personalization/authentication-setup/choosing-a-handshake", - "destination": "authentication-personalization/overview" - }, - { - "source": "settings/authentication-personalization/personalization-setup/choosing-a-handshake", - "destination": "authentication-personalization/overview" - }, - { - "source": "settings/authentication-personalization/authentication", - "destination": "authentication-personalization/authentication-setup" - }, - { - "source": "settings/authentication-personalization/personalization", - "destination": "authentication-personalization/personalization-setup" - }, - { - "source": "settings/authentication-personalization/partial-authentication", - "destination": "authentication-personalization/authentication-setup" - }, - { - "source": "settings/authentication-personalization/sending-data", - "destination": "authentication-personalization/personalization-setup" - }, - { - "source": "authentication-personalization/partial-authentication-setup", - "destination": "authentication-personalization/authentication-setup" - }, - { - "source": "authentication-personalization/sending-data", - "destination": "authentication-personalization/personalization-setup" - }, - { - "source": "settings/authentication-personalization/authentication-setup/jwt", - "destination": "authentication-personalization/authentication-setup" - }, - { - "source": "settings/authentication-personalization/authentication-setup/oauth", - "destination": "authentication-personalization/authentication-setup" - }, - { - "source": "settings/authentication-personalization/authentication-setup/mintlify", - "destination": "authentication-personalization/authentication-setup" - }, - { - "source": "settings/authentication-personalization/authentication-setup/password", - "destination": "authentication-personalization/authentication-setup" - }, - { - "source": "settings/authentication-personalization/personalization-setup/jwt", - "destination": "authentication-personalization/personalization-setup" - }, - { - "source": "settings/authentication-personalization/personalization-setup/oauth", - "destination": "authentication-personalization/personalization-setup" - }, - { - "source": "settings/authentication-personalization/personalization-setup/shared-session", - "destination": "authentication-personalization/personalization-setup" - }, - { - "source": "ai-ingestion", - "destination": "ai/llmstxt" - }, - { - "source": "api-reference/chat/*", - "destination": "api-reference/assistant/*" - }, - { - "source": "editor", - "destination": "editor/getting-started" - }, - { - "source": "guides/analytics", - "destination": "analytics/overview" - } + { + "source": "/content/components/accordions", + "destination": "/components/accordions" + }, + { + "source": "/content/components/callouts", + "destination": "/components/callouts" + }, + { + "source": "/content/components/cards", + "destination": "/components/cards" + }, + { + "source": "/content/components/card-groups", + "destination": "/components/columns" + }, + { + "source": "/content/components/code-groups", + "destination": "/components/code-groups" + }, + { + "source": "/content/components/examples", + "destination": "/components/examples" + }, + { + "source": "/content/components/expandables", + "destination": "/components/expandables" + }, + { + "source": "/content/components/fields", + "destination": "/components/fields" + }, + { + "source": "/content/components/frames", + "destination": "/components/frames" + }, + { + "source": "/content/components/icons", + "destination": "/components/icons" + }, + { + "source": "/content/components/mermaid-diagrams", + "destination": "/components/mermaid-diagrams" + }, + { + "source": "/content/components/steps", + "destination": "/components/steps" + }, + { + "source": "/content/components/tabs", + "destination": "/components/tabs" + }, + { + "source": "/content/components/tooltips", + "destination": "/components/tooltips" + }, + { + "source": "/content/components/update", + "destination": "/components/update" + }, + { + "source": "/api-playground/openapi/advanced-features", + "destination": "/api-playground/customization" + }, + { + "source": "/api-playground/openapi/setup", + "destination": "/api-playground/openapi-setup" + }, + { + "source": "/api-playground/openapi/writing-openapi", + "destination": "/api-playground/openapi-setup" + }, + { + "source": "settings/authentication-personalization/authentication-vs-personalization", + "destination": "authentication-personalization/overview" + }, + { + "source": "settings/authentication-personalization/authentication-setup/choosing-a-handshake", + "destination": "authentication-personalization/overview" + }, + { + "source": "settings/authentication-personalization/personalization-setup/choosing-a-handshake", + "destination": "authentication-personalization/overview" + }, + { + "source": "settings/authentication-personalization/authentication", + "destination": "authentication-personalization/authentication-setup" + }, + { + "source": "settings/authentication-personalization/personalization", + "destination": "authentication-personalization/personalization-setup" + }, + { + "source": "settings/authentication-personalization/partial-authentication", + "destination": "authentication-personalization/authentication-setup" + }, + { + "source": "settings/authentication-personalization/sending-data", + "destination": "authentication-personalization/personalization-setup" + }, + { + "source": "authentication-personalization/partial-authentication-setup", + "destination": "authentication-personalization/authentication-setup" + }, + { + "source": "authentication-personalization/sending-data", + "destination": "authentication-personalization/personalization-setup" + }, + { + "source": "settings/authentication-personalization/authentication-setup/jwt", + "destination": "authentication-personalization/authentication-setup" + }, + { + "source": "settings/authentication-personalization/authentication-setup/oauth", + "destination": "authentication-personalization/authentication-setup" + }, + { + "source": "settings/authentication-personalization/authentication-setup/mintlify", + "destination": "authentication-personalization/authentication-setup" + }, + { + "source": "settings/authentication-personalization/authentication-setup/password", + "destination": "authentication-personalization/authentication-setup" + }, + { + "source": "settings/authentication-personalization/personalization-setup/jwt", + "destination": "authentication-personalization/personalization-setup" + }, + { + "source": "settings/authentication-personalization/personalization-setup/oauth", + "destination": "authentication-personalization/personalization-setup" + }, + { + "source": "settings/authentication-personalization/personalization-setup/shared-session", + "destination": "authentication-personalization/personalization-setup" + }, + { + "source": "ai-ingestion", + "destination": "ai/llmstxt" + }, + { + "source": "api-reference/chat/*", + "destination": "api-reference/assistant/*" + }, + { + "source": "editor", + "destination": "editor/getting-started" + }, + { + "source": "guides/analytics", + "destination": "analytics/overview" + } ], "integrations": { - "ga4": { - "measurementId": "G-RCYWHL7EQ7" - }, - "koala": { - "publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8" - } + "ga4": { + "measurementId": "G-RCYWHL7EQ7" + }, + "koala": { + "publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8" + } } } \ No newline at end of file From ba17048db137632c1f5db013c27c7b2b51aba774 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 19 Sep 2025 13:36:56 -0700 Subject: [PATCH 02/43] rearrange pages --- docs.json | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/docs.json b/docs.json index c1b2eae34..3788fa933 100644 --- a/docs.json +++ b/docs.json @@ -54,7 +54,9 @@ "advanced/dashboard/permissions", "advanced/dashboard/roles" ] - } + }, + "authentication-personalization/authentication-setup", + "authentication-personalization/personalization-setup" ] }, { @@ -62,7 +64,8 @@ "pages": [ "pages", "navigation", - "settings" + "settings", + "guides/hidden-pages" ] }, { @@ -76,11 +79,6 @@ "group": "Components", "icon": "blocks", "pages": [ - "text", - "image-embeds", - "list-table", - "code", - "reusable-snippets", "components/accordions", "components/banner", "components/callouts", @@ -140,11 +138,10 @@ ] }, { - "group": "Publish", + "group": "Deploy", "pages": [ "guides/deployments", "settings/preview-deployments", - "guides/hidden-pages", { "group": "Custom subdirectory", "icon": "folder", @@ -157,8 +154,6 @@ ] }, "guides/monorepo", - "authentication-personalization/authentication-setup", - "authentication-personalization/personalization-setup", "settings/ci", "settings/github", "settings/gitlab" From 807061c19a06f6a9066c0c913f026ae03ab7dc39 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 19 Sep 2025 15:07:09 -0700 Subject: [PATCH 03/43] tag examples --- components/callouts.mdx | 1 + components/steps.mdx | 1 + docs.json | 1 + 3 files changed, 3 insertions(+) diff --git a/components/callouts.mdx b/components/callouts.mdx index af34a3283..bd5e41e4d 100644 --- a/components/callouts.mdx +++ b/components/callouts.mdx @@ -2,6 +2,7 @@ title: 'Callouts' description: 'Use callouts to add eye-catching context to your content' icon: 'info' +tag: "AI-optimized" --- Callouts can be styled as a Note, Warning, Info, Tip, Check, Danger, or create your own callout: diff --git a/components/steps.mdx b/components/steps.mdx index 3f5b1ba1e..e0581533d 100644 --- a/components/steps.mdx +++ b/components/steps.mdx @@ -2,6 +2,7 @@ title: "Steps" description: "Sequence content using the Steps component" icon: "list-todo" +tag: "AI-optimized" --- import IconsOptional from "/snippets/icons-optional.mdx"; diff --git a/docs.json b/docs.json index 3788fa933..7748a33f0 100644 --- a/docs.json +++ b/docs.json @@ -104,6 +104,7 @@ { "group": "API playground", "icon": "play", + "tag": "Popular", "pages": [ "api-playground/overview", "api-playground/openapi-setup", From 31e8279bafd37d7a8e1f4c09ef025c21d678c973 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 23 Sep 2025 13:38:37 -0700 Subject: [PATCH 04/43] add cookbook example --- ai/ready.mdx | 12 ++++++++++++ docs.json | 12 ++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 ai/ready.mdx diff --git a/ai/ready.mdx b/ai/ready.mdx new file mode 100644 index 000000000..d73fe90ca --- /dev/null +++ b/ai/ready.mdx @@ -0,0 +1,12 @@ +--- +title: "Make your docs ready for AI" +sidebarTitle: "AI-ready" +description: "Optimize your docs for use with AI tools" +icon: "cpu" +--- + +## Make your docs ready for AI + +### Add a description to your pages + +### Add a title to your pages diff --git a/docs.json b/docs.json index 7748a33f0..b408a21ba 100644 --- a/docs.json +++ b/docs.json @@ -35,6 +35,7 @@ "editor/troubleshooting" ] }, + "ai/ready", "guides/migration" ] }, @@ -269,6 +270,17 @@ } ] }, + { + "tab": "Cookbook", + "groups": [ + { + "group": "AI", + "pages": [ + "ai/ready" + ] + } + ] + }, { "tab": "Changelog", "groups": [ From 59e4eda04e9dda33ba2eaa38af8ad7d37574d8c5 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 24 Sep 2025 17:05:30 -0700 Subject: [PATCH 05/43] add a components menu --- docs.json | 135 +++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 124 insertions(+), 11 deletions(-) diff --git a/docs.json b/docs.json index b408a21ba..393e56d35 100644 --- a/docs.json +++ b/docs.json @@ -39,6 +39,15 @@ "guides/migration" ] }, + { + "group": "Organize", + "pages": [ + "pages", + "navigation", + "settings", + "guides/hidden-pages" + ] + }, { "group": "Customize", "pages": [ @@ -46,7 +55,6 @@ "settings/custom-domain", "settings/custom-scripts", "react-components", - "settings/custom-404-page", { "group": "Dashboard access", "icon": "gauge", @@ -57,16 +65,8 @@ ] }, "authentication-personalization/authentication-setup", - "authentication-personalization/personalization-setup" - ] - }, - { - "group": "Organize", - "pages": [ - "pages", - "navigation", - "settings", - "guides/hidden-pages" + "authentication-personalization/personalization-setup", + "settings/custom-404-page" ] }, { @@ -245,6 +245,119 @@ } ] }, + { + "tab": "Components", + "menu": [ + { + "item": "Accordions", + "pages": [ + "components/accordions" + ] + }, + { + "item": "Banner", + "pages": [ + "components/banner" + ] + }, + { + "item": "Callouts", + "pages": [ + "components/callouts" + ] + }, + { + "item": "Cards", + "pages": [ + "components/cards" + ] + }, + { + "item": "Code Groups", + "pages": [ + "components/code-groups" + ] + }, + { + "item": "Columns", + "pages": [ + "components/columns" + ] + }, + { + "item": "Examples", + "pages": [ + "components/examples" + ] + }, + { + "item": "Expandables", + "pages": [ + "components/expandables" + ] + }, + { + "item": "Fields", + "pages": [ + "components/fields" + ] + }, + { + "item": "Frames", + "pages": [ + "components/frames" + ] + }, + { + "item": "Icons", + "pages": [ + "components/icons" + ] + }, + { + "item": "Mermaid Diagrams", + "pages": [ + "components/mermaid-diagrams" + ] + }, + { + "item": "Panel", + "pages": [ + "components/panel" + ] + }, + { + "item": "Response fields", + "pages": [ + "components/responses" + ] + }, + { + "item": "Steps", + "pages": [ + "components/steps" + ] + }, + { + "item": "Tabs", + "pages": [ + "components/tabs" + ] + }, + { + "item": "Tooltips", + "pages": [ + "components/tooltips" + ] + }, + { + "item": "Update", + "pages": [ + "components/update" + ] + } + ] + }, { "tab": "API Reference", "groups": [ From 77a83366523ae96be955c8f52560136c3bbad060 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 24 Sep 2025 17:11:04 -0700 Subject: [PATCH 06/43] rename cookbook to guides --- docs.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs.json b/docs.json index 393e56d35..36d9f15da 100644 --- a/docs.json +++ b/docs.json @@ -384,7 +384,7 @@ ] }, { - "tab": "Cookbook", + "tab": "Guides", "groups": [ { "group": "AI", From efb2973687cb4b3f1e612c789bb55d3e762bd5a7 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 25 Sep 2025 09:49:46 -0700 Subject: [PATCH 07/43] fix docs.json after adding translations --- docs.json | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/docs.json b/docs.json index 9e3284ff3..6fd63c993 100644 --- a/docs.json +++ b/docs.json @@ -14,7 +14,8 @@ "navigation": { "languages": [ { - { + "tabs": [ + { "tab": "Documentation", "groups": [ { @@ -243,21 +244,21 @@ }, "contact-support" ] - } - ] - }, - { - "tab": "Components", - "menu": [ - { - "item": "Accordions", - "pages": [ - "components/accordions" - ] + } + ] }, { - "item": "Banner", - "pages": [ + "tab": "Components", + "menu": [ + { + "item": "Accordions", + "pages": [ + "components/accordions" + ] + }, + { + "item": "Banner", + "pages": [ "components/banner" ] }, @@ -406,8 +407,8 @@ } ] } - ] - "language": "en" + ], + "language": "en" }, { "tabs": [ From 024fe78cd2131170dfcb326a6e8b3d54db16d75d Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 25 Sep 2025 09:50:21 -0700 Subject: [PATCH 08/43] prettier docs.json --- docs.json | 1118 +++++++++++++++++++++++++---------------------------- 1 file changed, 529 insertions(+), 589 deletions(-) diff --git a/docs.json b/docs.json index 6fd63c993..52ec96a48 100644 --- a/docs.json +++ b/docs.json @@ -3,412 +3,370 @@ "theme": "maple", "name": "Mintlify", "colors": { - "primary": "#0D9373", - "light": "#55D799", - "dark": "#0D9373" + "primary": "#0D9373", + "light": "#55D799", + "dark": "#0D9373" }, "favicon": "/favicon.ico", "icons": { - "library": "lucide" + "library": "lucide" }, "navigation": { "languages": [ { "tabs": [ { - "tab": "Documentation", - "groups": [ - { - "group": "Get started", - "pages": [ - "index", - "quickstart", - "installation", - { - "group": "Visual editor", - "icon": "mouse-pointer-2", - "pages": [ - "editor/getting-started", - "editor/git-concepts", - "editor/branches", - "editor/content-management", - "editor/publishing", - "editor/keyboard-shortcuts", - "editor/troubleshooting" - ] - }, - "ai/ready", - "guides/migration" - ] + "tab": "Documentation", + "groups": [ + { + "group": "Get started", + "pages": [ + "index", + "quickstart", + "installation", + { + "group": "Visual editor", + "icon": "mouse-pointer-2", + "pages": [ + "editor/getting-started", + "editor/git-concepts", + "editor/branches", + "editor/content-management", + "editor/publishing", + "editor/keyboard-shortcuts", + "editor/troubleshooting" + ] + }, + "ai/ready", + "guides/migration" + ] }, { "group": "Organize", "pages": [ - "pages", - "navigation", - "settings", - "guides/hidden-pages" + "pages", + "navigation", + "settings", + "guides/hidden-pages" + ] + }, + { + "group": "Customize", + "pages": [ + "themes", + "settings/custom-domain", + "settings/custom-scripts", + "react-components", + { + "group": "Dashboard access", + "icon": "gauge", + "pages": [ + "advanced/dashboard/sso", + "advanced/dashboard/permissions", + "advanced/dashboard/roles" + ] + }, + "authentication-personalization/authentication-setup", + "authentication-personalization/personalization-setup", + "settings/custom-404-page" ] }, { - "group": "Customize", - "pages": [ - "themes", - "settings/custom-domain", - "settings/custom-scripts", - "react-components", + "group": "Write and edit", + "pages": [ + "text", + "code", + "image-embeds", + "list-table", + { + "group": "Components", + "icon": "blocks", + "pages": [ + "components/accordions", + "components/banner", + "components/callouts", + "components/cards", + "components/code-groups", + "components/columns", + "components/examples", + "components/expandables", + "components/fields", + "components/frames", + "components/icons", + "components/mermaid-diagrams", + "components/panel", + "components/responses", + "components/steps", + "components/tabs", + "components/tooltips", + "components/update" + ] + }, + "reusable-snippets", + "settings/broken-links", + { + "group": "API playground", + "icon": "play", + "tag": "Popular", + "pages": [ + "api-playground/overview", + "api-playground/openapi-setup", + "api-playground/migrating-from-mdx", { - "group": "Dashboard access", - "icon": "gauge", + "group": "Customization", "pages": [ - "advanced/dashboard/sso", - "advanced/dashboard/permissions", - "advanced/dashboard/roles" + "api-playground/customization/complex-data-types", + "api-playground/customization/adding-sdk-examples", + "api-playground/customization/managing-page-visibility", + "api-playground/customization/multiple-responses" ] - }, - "authentication-personalization/authentication-setup", - "authentication-personalization/personalization-setup", - "settings/custom-404-page" - ] - }, - { - "group": "Write and edit", - "pages": [ - "text", - "code", - "image-embeds", - "list-table", + }, { - "group": "Components", - "icon": "blocks", - "pages": [ - "components/accordions", - "components/banner", - "components/callouts", - "components/cards", - "components/code-groups", - "components/columns", - "components/examples", - "components/expandables", - "components/fields", - "components/frames", - "components/icons", - "components/mermaid-diagrams", - "components/panel", - "components/responses", - "components/steps", - "components/tabs", - "components/tooltips", - "components/update" - ] + "group": "MDX", + "pages": [ + "api-playground/mdx/configuration", + "api-playground/mdx/authentication" + ] }, - "reusable-snippets", - "settings/broken-links", { - "group": "API playground", - "icon": "play", - "tag": "Popular", - "pages": [ - "api-playground/overview", - "api-playground/openapi-setup", - "api-playground/migrating-from-mdx", - { - "group": "Customization", - "pages": [ - "api-playground/customization/complex-data-types", - "api-playground/customization/adding-sdk-examples", - "api-playground/customization/managing-page-visibility", - "api-playground/customization/multiple-responses" - ] - }, - { - "group": "MDX", - "pages": [ - "api-playground/mdx/configuration", - "api-playground/mdx/authentication" - ] - }, - { - "group": "AsyncAPI", - "pages": [ - "api-playground/asyncapi/setup", - "api-playground/asyncapi/playground" - ] - }, - "api-playground/troubleshooting" - ] + "group": "AsyncAPI", + "pages": [ + "api-playground/asyncapi/setup", + "api-playground/asyncapi/playground" + ] }, - "guides/changelogs" - ] + "api-playground/troubleshooting" + ] + }, + "guides/changelogs" + ] }, { - "group": "Deploy", - "pages": [ - "guides/deployments", - "settings/preview-deployments", - { - "group": "Custom subdirectory", - "icon": "folder", - "pages": [ - "advanced/subpath/cloudflare", - "advanced/subpath/route53-cloudfront", - "advanced/subpath/vercel", - "guides/reverse-proxy", - "guides/csp-configuration" - ] - }, - "guides/monorepo", - "settings/ci", - "settings/github", - "settings/gitlab" - ] + "group": "Deploy", + "pages": [ + "guides/deployments", + "settings/preview-deployments", + { + "group": "Custom subdirectory", + "icon": "folder", + "pages": [ + "advanced/subpath/cloudflare", + "advanced/subpath/route53-cloudfront", + "advanced/subpath/vercel", + "guides/reverse-proxy", + "guides/csp-configuration" + ] + }, + "guides/monorepo", + "settings/ci", + "settings/github", + "settings/gitlab" + ] }, { - "group": "Optimize", - "pages": [ + "group": "Optimize", + "pages": [ + { + "group": "AI", + "icon": "bot", + "pages": [ + "guides/assistant", + "ai/llmstxt", + "ai/contextual-menu", + "ai/model-context-protocol", + "ai/markdown-export", + "guides/geo", + "ai/slack-app" + ] + }, + { + "group": "Analytics", + "icon": "chart-line", + "pages": [ + "analytics/overview", + "analytics/feedback", + "analytics/search", + "analytics/improving-docs" + ] + }, + "settings/seo", + { + "group": "Integrations", + "icon": "folder-code", + "pages": [ + "guides/claude-code", + "guides/cursor", + "guides/windsurf", { - "group": "AI", - "icon": "bot", - "pages": [ - "guides/assistant", - "ai/llmstxt", - "ai/contextual-menu", - "ai/model-context-protocol", - "ai/markdown-export", - "guides/geo", - "ai/slack-app" - ] + "group": "Analytics", + "pages": [ + "integrations/analytics/overview", + "integrations/analytics/amplitude", + "integrations/analytics/clearbit", + "integrations/analytics/fathom", + "integrations/analytics/google-analytics", + "integrations/analytics/google-tag-manager", + "integrations/analytics/heap", + "integrations/analytics/hightouch", + "integrations/analytics/hotjar", + "integrations/analytics/koala", + "integrations/analytics/logrocket", + "integrations/analytics/mixpanel", + "integrations/analytics/pirsch", + "integrations/analytics/plausible", + "integrations/analytics/posthog", + "integrations/analytics/segment" + ] }, { - "group": "Analytics", - "icon": "chart-line", - "pages": [ - "analytics/overview", - "analytics/feedback", - "analytics/search", - "analytics/improving-docs" - ] + "group": "SDKs", + "pages": [ + "integrations/sdks/speakeasy", + "integrations/sdks/stainless" + ] }, - "settings/seo", { - "group": "Integrations", - "icon": "folder-code", - "pages": [ - "guides/claude-code", - "guides/cursor", - "guides/windsurf", - { - "group": "Analytics", - "pages": [ - "integrations/analytics/overview", - "integrations/analytics/amplitude", - "integrations/analytics/clearbit", - "integrations/analytics/fathom", - "integrations/analytics/google-analytics", - "integrations/analytics/google-tag-manager", - "integrations/analytics/heap", - "integrations/analytics/hightouch", - "integrations/analytics/hotjar", - "integrations/analytics/koala", - "integrations/analytics/logrocket", - "integrations/analytics/mixpanel", - "integrations/analytics/pirsch", - "integrations/analytics/plausible", - "integrations/analytics/posthog", - "integrations/analytics/segment" - ] - }, - { - "group": "SDKs", - "pages": [ - "integrations/sdks/speakeasy", - "integrations/sdks/stainless" - ] - }, - { - "group": "Support", - "pages": [ - "integrations/support/overview", - "integrations/support/intercom", - "integrations/support/front" - ] - }, - { - "group": "Privacy", - "pages": [ - "integrations/privacy/overview", - "integrations/privacy/osano" - ] - } - ] + "group": "Support", + "pages": [ + "integrations/support/overview", + "integrations/support/intercom", + "integrations/support/front" + ] }, - "contact-support" - ] - } - ] + { + "group": "Privacy", + "pages": [ + "integrations/privacy/overview", + "integrations/privacy/osano" + ] + } + ] + }, + "contact-support" + ] + } + ] }, { "tab": "Components", "menu": [ { "item": "Accordions", - "pages": [ - "components/accordions" - ] + "pages": ["components/accordions"] }, { "item": "Banner", - "pages": [ - "components/banner" - ] + "pages": ["components/banner"] }, { - "item": "Callouts", - "pages": [ - "components/callouts" - ] + "item": "Callouts", + "pages": ["components/callouts"] }, { - "item": "Cards", - "pages": [ - "components/cards" - ] + "item": "Cards", + "pages": ["components/cards"] }, { - "item": "Code Groups", - "pages": [ - "components/code-groups" - ] + "item": "Code Groups", + "pages": ["components/code-groups"] }, { - "item": "Columns", - "pages": [ - "components/columns" - ] + "item": "Columns", + "pages": ["components/columns"] }, { - "item": "Examples", - "pages": [ - "components/examples" - ] + "item": "Examples", + "pages": ["components/examples"] }, { - "item": "Expandables", - "pages": [ - "components/expandables" - ] + "item": "Expandables", + "pages": ["components/expandables"] }, { - "item": "Fields", - "pages": [ - "components/fields" - ] + "item": "Fields", + "pages": ["components/fields"] }, { - "item": "Frames", - "pages": [ - "components/frames" - ] + "item": "Frames", + "pages": ["components/frames"] }, { - "item": "Icons", - "pages": [ - "components/icons" - ] + "item": "Icons", + "pages": ["components/icons"] }, { - "item": "Mermaid Diagrams", - "pages": [ - "components/mermaid-diagrams" - ] + "item": "Mermaid Diagrams", + "pages": ["components/mermaid-diagrams"] }, { - "item": "Panel", - "pages": [ - "components/panel" - ] + "item": "Panel", + "pages": ["components/panel"] }, { - "item": "Response fields", - "pages": [ - "components/responses" - ] + "item": "Response fields", + "pages": ["components/responses"] }, { - "item": "Steps", - "pages": [ - "components/steps" - ] + "item": "Steps", + "pages": ["components/steps"] }, { - "item": "Tabs", - "pages": [ - "components/tabs" - ] + "item": "Tabs", + "pages": ["components/tabs"] }, { - "item": "Tooltips", - "pages": [ - "components/tooltips" - ] + "item": "Tooltips", + "pages": ["components/tooltips"] }, { - "item": "Update", - "pages": [ - "components/update" - ] + "item": "Update", + "pages": ["components/update"] } ] }, { - "tab": "API Reference", - "groups": [ - { - "group": "API Reference", - "pages": [ - "api-reference/introduction" - ] - }, - { - "group": "Admin", - "pages": [ - "api-reference/update/trigger", - "api-reference/update/status" - ] - }, - { - "group": "Assistant", - "pages": [ - "api-reference/assistant/create-assistant-message", - "api-reference/assistant/search" - ] - } - ] + "tab": "API Reference", + "groups": [ + { + "group": "API Reference", + "pages": ["api-reference/introduction"] + }, + { + "group": "Admin", + "pages": [ + "api-reference/update/trigger", + "api-reference/update/status" + ] + }, + { + "group": "Assistant", + "pages": [ + "api-reference/assistant/create-assistant-message", + "api-reference/assistant/search" + ] + } + ] }, { - "tab": "Guides", - "groups": [ - { - "group": "AI", - "pages": [ - "ai/ready" - ] - } - ] + "tab": "Guides", + "groups": [ + { + "group": "AI", + "pages": ["ai/ready"] + } + ] }, { - "tab": "Changelog", - "groups": [ - { - "group": "Changelog", - "pages": [ - "changelog" - ] - } - ] + "tab": "Changelog", + "groups": [ + { + "group": "Changelog", + "pages": ["changelog"] + } + ] } ], - "language": "en" + "language": "en" }, { "tabs": [ @@ -643,9 +601,7 @@ "groups": [ { "group": "Référence API", - "pages": [ - "fr/api-reference/introduction" - ] + "pages": ["fr/api-reference/introduction"] }, { "group": "Admin", @@ -668,9 +624,7 @@ "groups": [ { "group": "Journal des modifications", - "pages": [ - "fr/changelog" - ] + "pages": ["fr/changelog"] } ] } @@ -910,9 +864,7 @@ "groups": [ { "group": "Referencia de la API", - "pages": [ - "es/api-reference/introduction" - ] + "pages": ["es/api-reference/introduction"] }, { "group": "Administración", @@ -935,9 +887,7 @@ "groups": [ { "group": "Registro de cambios", - "pages": [ - "es/changelog" - ] + "pages": ["es/changelog"] } ] } @@ -1177,9 +1127,7 @@ "groups": [ { "group": "API 参考", - "pages": [ - "zh/api-reference/introduction" - ] + "pages": ["zh/api-reference/introduction"] }, { "group": "管理员", @@ -1202,9 +1150,7 @@ "groups": [ { "group": "变更日志", - "pages": [ - "zh/changelog" - ] + "pages": ["zh/changelog"] } ] } @@ -1214,277 +1160,271 @@ ] }, "logo": { - "light": "/logo/light.svg", - "dark": "/logo/dark.svg", - "href": "https://mintlify.com/docs" + "light": "/logo/light.svg", + "dark": "/logo/dark.svg", + "href": "https://mintlify.com/docs" }, "api": { - "mdx": { - "auth": { - "method": "bearer" - } + "mdx": { + "auth": { + "method": "bearer" } + } }, "navbar": { - "primary": { - "type": "button", - "label": "Get started", - "href": "https://mintlify.com/start" - } + "primary": { + "type": "button", + "label": "Get started", + "href": "https://mintlify.com/start" + } }, "footer": { - "socials": { - "x": "https://x.com/mintlify", - "linkedin": "https://www.linkedin.com/company/mintlify", - "github": "https://github.com/mintlify" + "socials": { + "x": "https://x.com/mintlify", + "linkedin": "https://www.linkedin.com/company/mintlify", + "github": "https://github.com/mintlify" + }, + "links": [ + { + "header": "Explore", + "items": [ + { + "label": "Startups", + "href": "https://www.mintlify.com/startups" + }, + { + "label": "Enterprise", + "href": "https://www.mintlify.com/enterprise" + }, + { + "label": "Switch", + "href": "https://www.mintlify.com/switch" + } + ] }, - "links": [ + { + "header": "Resources", + "items": [ { - "header": "Explore", - "items": [ - { - "label": "Startups", - "href": "https://www.mintlify.com/startups" - }, - { - "label": "Enterprise", - "href": "https://www.mintlify.com/enterprise" - }, - { - "label": "Switch", - "href": "https://www.mintlify.com/switch" - } - ] + "label": "Customers", + "href": "https://mintlify.com/customers" }, { - "header": "Resources", - "items": [ - { - "label": "Customers", - "href": "https://mintlify.com/customers" - }, - { - "label": "Blog", - "href": "https://mintlify.com/blog" - }, - { - "label": "Pricing", - "href": "https://www.mintlify.com/pricing" - }, - { - "label": "Guides", - "href": "https://www.mintlify.com/guides" - }, - { - "label": "Feature Requests", - "href": "https://github.com/orgs/mintlify/discussions/categories/feature-requests" - } - ] + "label": "Blog", + "href": "https://mintlify.com/blog" }, { - "header": "Company", - "items": [ - { - "label": "Careers", - "href": "https://mintlify.com/careers" - }, - { - "label": "Wall of Love", - "href": "https://www.mintlify.com/wall-of-love" - } - ] + "label": "Pricing", + "href": "https://www.mintlify.com/pricing" }, { - "header": "Legal", - "items": [ - { - "label": "Privacy Policy", - "href": "https://mintlify.com/legal/privacy" - }, - { - "label": "Terms of Service", - "href": "https://mintlify.com/legal/terms" - }, - { - "label": "Security", - "href": "https://security.mintlify.com/?_gl=1*ascm4x*_gcl_au*NTU1ODkzNjQ0LjE3NTQ5Mjg4NzIuMTgzMDQ5NTExMS4xNzU3NTQwMDk1LjE3NTc1NDAwOTQ." - } - ] + "label": "Guides", + "href": "https://www.mintlify.com/guides" + }, + { + "label": "Feature Requests", + "href": "https://github.com/orgs/mintlify/discussions/categories/feature-requests" + } + ] + }, + { + "header": "Company", + "items": [ + { + "label": "Careers", + "href": "https://mintlify.com/careers" + }, + { + "label": "Wall of Love", + "href": "https://www.mintlify.com/wall-of-love" + } + ] + }, + { + "header": "Legal", + "items": [ + { + "label": "Privacy Policy", + "href": "https://mintlify.com/legal/privacy" + }, + { + "label": "Terms of Service", + "href": "https://mintlify.com/legal/terms" + }, + { + "label": "Security", + "href": "https://security.mintlify.com/?_gl=1*ascm4x*_gcl_au*NTU1ODkzNjQ0LjE3NTQ5Mjg4NzIuMTgzMDQ5NTExMS4xNzU3NTQwMDk1LjE3NTc1NDAwOTQ." } - ] + ] + } + ] }, "thumbnails": { - "background": "/images/thumbnail/background.svg" + "background": "/images/thumbnail/background.svg" }, "contextual": { - "options": [ - "copy", - "chatgpt", - "claude", - "cursor", - "vscode" - ] + "options": ["copy", "chatgpt", "claude", "cursor", "vscode"] }, "redirects": [ - { - "source": "/content/components/accordions", - "destination": "/components/accordions" - }, - { - "source": "/content/components/callouts", - "destination": "/components/callouts" - }, - { - "source": "/content/components/cards", - "destination": "/components/cards" - }, - { - "source": "/content/components/card-groups", - "destination": "/components/columns" - }, - { - "source": "/content/components/code-groups", - "destination": "/components/code-groups" - }, - { - "source": "/content/components/examples", - "destination": "/components/examples" - }, - { - "source": "/content/components/expandables", - "destination": "/components/expandables" - }, - { - "source": "/content/components/fields", - "destination": "/components/fields" - }, - { - "source": "/content/components/frames", - "destination": "/components/frames" - }, - { - "source": "/content/components/icons", - "destination": "/components/icons" - }, - { - "source": "/content/components/mermaid-diagrams", - "destination": "/components/mermaid-diagrams" - }, - { - "source": "/content/components/steps", - "destination": "/components/steps" - }, - { - "source": "/content/components/tabs", - "destination": "/components/tabs" - }, - { - "source": "/content/components/tooltips", - "destination": "/components/tooltips" - }, - { - "source": "/content/components/update", - "destination": "/components/update" - }, - { - "source": "/api-playground/openapi/advanced-features", - "destination": "/api-playground/customization" - }, - { - "source": "/api-playground/openapi/setup", - "destination": "/api-playground/openapi-setup" - }, - { - "source": "/api-playground/openapi/writing-openapi", - "destination": "/api-playground/openapi-setup" - }, - { - "source": "settings/authentication-personalization/authentication-vs-personalization", - "destination": "authentication-personalization/overview" - }, - { - "source": "settings/authentication-personalization/authentication-setup/choosing-a-handshake", - "destination": "authentication-personalization/overview" - }, - { - "source": "settings/authentication-personalization/personalization-setup/choosing-a-handshake", - "destination": "authentication-personalization/overview" - }, - { - "source": "settings/authentication-personalization/authentication", - "destination": "authentication-personalization/authentication-setup" - }, - { - "source": "settings/authentication-personalization/personalization", - "destination": "authentication-personalization/personalization-setup" - }, - { - "source": "settings/authentication-personalization/partial-authentication", - "destination": "authentication-personalization/authentication-setup" - }, - { - "source": "settings/authentication-personalization/sending-data", - "destination": "authentication-personalization/personalization-setup" - }, - { - "source": "authentication-personalization/partial-authentication-setup", - "destination": "authentication-personalization/authentication-setup" - }, - { - "source": "authentication-personalization/sending-data", - "destination": "authentication-personalization/personalization-setup" - }, - { - "source": "settings/authentication-personalization/authentication-setup/jwt", - "destination": "authentication-personalization/authentication-setup" - }, - { - "source": "settings/authentication-personalization/authentication-setup/oauth", - "destination": "authentication-personalization/authentication-setup" - }, - { - "source": "settings/authentication-personalization/authentication-setup/mintlify", - "destination": "authentication-personalization/authentication-setup" - }, - { - "source": "settings/authentication-personalization/authentication-setup/password", - "destination": "authentication-personalization/authentication-setup" - }, - { - "source": "settings/authentication-personalization/personalization-setup/jwt", - "destination": "authentication-personalization/personalization-setup" - }, - { - "source": "settings/authentication-personalization/personalization-setup/oauth", - "destination": "authentication-personalization/personalization-setup" - }, - { - "source": "settings/authentication-personalization/personalization-setup/shared-session", - "destination": "authentication-personalization/personalization-setup" - }, - { - "source": "ai-ingestion", - "destination": "ai/llmstxt" - }, - { - "source": "api-reference/chat/*", - "destination": "api-reference/assistant/*" - }, - { - "source": "editor", - "destination": "editor/getting-started" - }, - { - "source": "guides/analytics", - "destination": "analytics/overview" - } + { + "source": "/content/components/accordions", + "destination": "/components/accordions" + }, + { + "source": "/content/components/callouts", + "destination": "/components/callouts" + }, + { + "source": "/content/components/cards", + "destination": "/components/cards" + }, + { + "source": "/content/components/card-groups", + "destination": "/components/columns" + }, + { + "source": "/content/components/code-groups", + "destination": "/components/code-groups" + }, + { + "source": "/content/components/examples", + "destination": "/components/examples" + }, + { + "source": "/content/components/expandables", + "destination": "/components/expandables" + }, + { + "source": "/content/components/fields", + "destination": "/components/fields" + }, + { + "source": "/content/components/frames", + "destination": "/components/frames" + }, + { + "source": "/content/components/icons", + "destination": "/components/icons" + }, + { + "source": "/content/components/mermaid-diagrams", + "destination": "/components/mermaid-diagrams" + }, + { + "source": "/content/components/steps", + "destination": "/components/steps" + }, + { + "source": "/content/components/tabs", + "destination": "/components/tabs" + }, + { + "source": "/content/components/tooltips", + "destination": "/components/tooltips" + }, + { + "source": "/content/components/update", + "destination": "/components/update" + }, + { + "source": "/api-playground/openapi/advanced-features", + "destination": "/api-playground/customization" + }, + { + "source": "/api-playground/openapi/setup", + "destination": "/api-playground/openapi-setup" + }, + { + "source": "/api-playground/openapi/writing-openapi", + "destination": "/api-playground/openapi-setup" + }, + { + "source": "settings/authentication-personalization/authentication-vs-personalization", + "destination": "authentication-personalization/overview" + }, + { + "source": "settings/authentication-personalization/authentication-setup/choosing-a-handshake", + "destination": "authentication-personalization/overview" + }, + { + "source": "settings/authentication-personalization/personalization-setup/choosing-a-handshake", + "destination": "authentication-personalization/overview" + }, + { + "source": "settings/authentication-personalization/authentication", + "destination": "authentication-personalization/authentication-setup" + }, + { + "source": "settings/authentication-personalization/personalization", + "destination": "authentication-personalization/personalization-setup" + }, + { + "source": "settings/authentication-personalization/partial-authentication", + "destination": "authentication-personalization/authentication-setup" + }, + { + "source": "settings/authentication-personalization/sending-data", + "destination": "authentication-personalization/personalization-setup" + }, + { + "source": "authentication-personalization/partial-authentication-setup", + "destination": "authentication-personalization/authentication-setup" + }, + { + "source": "authentication-personalization/sending-data", + "destination": "authentication-personalization/personalization-setup" + }, + { + "source": "settings/authentication-personalization/authentication-setup/jwt", + "destination": "authentication-personalization/authentication-setup" + }, + { + "source": "settings/authentication-personalization/authentication-setup/oauth", + "destination": "authentication-personalization/authentication-setup" + }, + { + "source": "settings/authentication-personalization/authentication-setup/mintlify", + "destination": "authentication-personalization/authentication-setup" + }, + { + "source": "settings/authentication-personalization/authentication-setup/password", + "destination": "authentication-personalization/authentication-setup" + }, + { + "source": "settings/authentication-personalization/personalization-setup/jwt", + "destination": "authentication-personalization/personalization-setup" + }, + { + "source": "settings/authentication-personalization/personalization-setup/oauth", + "destination": "authentication-personalization/personalization-setup" + }, + { + "source": "settings/authentication-personalization/personalization-setup/shared-session", + "destination": "authentication-personalization/personalization-setup" + }, + { + "source": "ai-ingestion", + "destination": "ai/llmstxt" + }, + { + "source": "api-reference/chat/*", + "destination": "api-reference/assistant/*" + }, + { + "source": "editor", + "destination": "editor/getting-started" + }, + { + "source": "guides/analytics", + "destination": "analytics/overview" + } ], "integrations": { - "ga4": { - "measurementId": "G-RCYWHL7EQ7" - }, - "koala": { - "publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8" - } + "ga4": { + "measurementId": "G-RCYWHL7EQ7" + }, + "koala": { + "publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8" + } } -} \ No newline at end of file +} From acd894f30f1f751aa2206ee11843147499289151 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 25 Sep 2025 10:53:14 -0700 Subject: [PATCH 09/43] move content to Guides --- docs.json | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs.json b/docs.json index 52ec96a48..c4cb06daf 100644 --- a/docs.json +++ b/docs.json @@ -29,9 +29,6 @@ "icon": "mouse-pointer-2", "pages": [ "editor/getting-started", - "editor/git-concepts", - "editor/branches", - "editor/content-management", "editor/publishing", "editor/keyboard-shortcuts", "editor/troubleshooting" @@ -353,6 +350,14 @@ { "group": "AI", "pages": ["ai/ready"] + }, + { + "group": "Git", + "pages": [ + "editor/git-concepts", + "editor/branches", + "editor/content-management" + ] } ] }, From 005907bfafd4dd244751e982c9397f0367f56bc5 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 25 Sep 2025 15:10:31 -0700 Subject: [PATCH 10/43] move GEO page to guides --- docs.json | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs.json b/docs.json index c4cb06daf..b65fd3b9d 100644 --- a/docs.json +++ b/docs.json @@ -34,7 +34,7 @@ "editor/troubleshooting" ] }, - "ai/ready", + "ai-native", "guides/migration" ] }, @@ -172,7 +172,6 @@ "ai/contextual-menu", "ai/model-context-protocol", "ai/markdown-export", - "guides/geo", "ai/slack-app" ] }, @@ -349,7 +348,9 @@ "groups": [ { "group": "AI", - "pages": ["ai/ready"] + "pages": [ + "guides/geo" + ] }, { "group": "Git", From 0a1e8619cd5baa3d044a9fa726a590c26e322724 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 26 Sep 2025 11:11:00 -0700 Subject: [PATCH 11/43] draft of ai-native page --- ai-native.mdx | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++ ai/ready.mdx | 12 ------------ 2 files changed, 53 insertions(+), 12 deletions(-) create mode 100644 ai-native.mdx delete mode 100644 ai/ready.mdx diff --git a/ai-native.mdx b/ai-native.mdx new file mode 100644 index 000000000..9526d9cab --- /dev/null +++ b/ai-native.mdx @@ -0,0 +1,53 @@ +--- +title: "AI-native docs" +description: "Learn how AI enhances reading, writing, and distributing your docs" +icon: "cpu" +--- + +When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. + +Here's how these features enhance the user and maintainer experiences of your docs. + +## What makes your docs AI-native + +Mintlify's AI features analyze your docs to create better experiences for both users and maintainers. For users, they enhance content discovery across the web and AI tools. For maintainers, they assist with writing and updating content. + +### Structured content +Your MDX pages generate semantic HTML with proper heading hierarchies, which makes it easy for AI tools to understand and reference your content. + +### Rich metadata +Page frontmatter—like titles, descriptions, and tags—provides context that helps AI tools understand the purpose and scope of each page. + +### Search-optimized +Full-text search and semantic understanding help users and AI tools find relevant information quickly. + +### Content suggestions +The assistant feature can recommend related pages and guide users to relevant information. + +### Copy-to-AI workflows +Users can quickly copy content to their preferred AI tools with proper context preservation. + +## Enable additional AI features + +Select any of the following cards for more information. + + + + Add an AI chat assistant to help users find answers instantly + + + Let users copy content directly to ChatGPT, Claude, and other AI tools + + + Provide structured data for AI crawlers and tools + + + Connect your docs directly to Claude Desktop and other MCP-compatible tools + + + Export your docs as markdown for AI training and fine-tuning + + + Built-in support for Claude Code, Cursor, and Windsurf + + diff --git a/ai/ready.mdx b/ai/ready.mdx deleted file mode 100644 index d73fe90ca..000000000 --- a/ai/ready.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "Make your docs ready for AI" -sidebarTitle: "AI-ready" -description: "Optimize your docs for use with AI tools" -icon: "cpu" ---- - -## Make your docs ready for AI - -### Add a description to your pages - -### Add a title to your pages From 94081e91478d0ba374cec3e4ba685cd9b662efa1 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 26 Sep 2025 14:07:35 -0700 Subject: [PATCH 12/43] update body with info on reading/distributing --- ai-native.mdx | 46 ++++++++++++++++++++++------------------------ 1 file changed, 22 insertions(+), 24 deletions(-) diff --git a/ai-native.mdx b/ai-native.mdx index 9526d9cab..ca829d966 100644 --- a/ai-native.mdx +++ b/ai-native.mdx @@ -6,48 +6,46 @@ icon: "cpu" When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. +TODO: AI-native features analyze your docs to create better experiences for users and maintainers. + +TODO: For users, AI-native features enhance content discovery across the web and AI tools. For maintainers, they assist with writing and updating content. + Here's how these features enhance the user and maintainer experiences of your docs. ## What makes your docs AI-native -Mintlify's AI features analyze your docs to create better experiences for both users and maintainers. For users, they enhance content discovery across the web and AI tools. For maintainers, they assist with writing and updating content. +### Content suggestions +Users can chat with the assistant to get answers and links to relevant pages to guide them through using your product. -### Structured content -Your MDX pages generate semantic HTML with proper heading hierarchies, which makes it easy for AI tools to understand and reference your content. +### Search-optimized +Mintlify automatically hosts `llms.txt` and `llms-full.txt` files for your docs. These files are an industry standard that help LLMs index content. AI tools use these files to process the structure of your documentation and find content relevant to user queries. -### Rich metadata -Page frontmatter—like titles, descriptions, and tags—provides context that helps AI tools understand the purpose and scope of each page. +Mintlify also hosts an MCP server for your docs site that lets users connect your docs directly to their AI tools so that they have up to date information about your product directly where they want it. -### Search-optimized -Full-text search and semantic understanding help users and AI tools find relevant information quickly. +Full-text search and semantic understanding help users and AI tools find relevant information quickly. Search on your docs understands user intent rather than just matching keywords. -### Content suggestions -The assistant feature can recommend related pages and guide users to relevant information. +If a user encounters a 404 error, your site suggests related pages to help them find what they're looking for. No configuration required. + +### Structured content +Your MDX pages generate semantic HTML with proper heading hierarchies, which makes it easy for AI tools to understand and reference your content. Every page is available as Markdown by appending `.md` to the page's URL. -### Copy-to-AI workflows -Users can quickly copy content to their preferred AI tools with proper context preservation. +Page frontmatter—like titles, descriptions, and tags—provides context that helps AI tools understand the purpose and scope of each page. ## Enable additional AI features Select any of the following cards for more information. - - Add an AI chat assistant to help users find answers instantly - - - Let users copy content directly to ChatGPT, Claude, and other AI tools + + Configure the assistant to search external sites or direct people to your support team if it can't answer their questions. - - Provide structured data for AI crawlers and tools + + Add a menu to pages that lets users query AI tools, connect to your MCP server, and copy pages as context with one click. - Connect your docs directly to Claude Desktop and other MCP-compatible tools - - - Export your docs as markdown for AI training and fine-tuning + Make your users aware of your MCP server and how to connect to it. - - Built-in support for Claude Code, Cursor, and Windsurf + + Configure [Claude Code](/guides/claude-code), [Cursor](/guides/cursor), or [Windsurf](/guides/windsurf) to help write, review and update your docs. From 271a2173483e0a7a944b61680eb2a267abaafe3a Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 26 Sep 2025 14:45:48 -0700 Subject: [PATCH 13/43] copy edits --- ai-native.mdx | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/ai-native.mdx b/ai-native.mdx index ca829d966..76a568712 100644 --- a/ai-native.mdx +++ b/ai-native.mdx @@ -4,18 +4,14 @@ description: "Learn how AI enhances reading, writing, and distributing your docs icon: "cpu" --- -When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. - -TODO: AI-native features analyze your docs to create better experiences for users and maintainers. - -TODO: For users, AI-native features enhance content discovery across the web and AI tools. For maintainers, they assist with writing and updating content. - -Here's how these features enhance the user and maintainer experiences of your docs. +When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. These AI-native features use the content in your docs to improve the experience of reading, writing, and distributing your docs. ## What makes your docs AI-native ### Content suggestions -Users can chat with the assistant to get answers and links to relevant pages to guide them through using your product. +Users can chat with the assistant to get answers and links to relevant pages to guide them through using your product. Embed the assistant into custom apps with the [API](api-reference/assistant/create-assistant-message). + +If a user encounters a 404 error, your site suggests related pages to help them find what they're looking for. No configuration required. ### Search-optimized Mintlify automatically hosts `llms.txt` and `llms-full.txt` files for your docs. These files are an industry standard that help LLMs index content. AI tools use these files to process the structure of your documentation and find content relevant to user queries. @@ -24,8 +20,6 @@ Mintlify also hosts an MCP server for your docs site that lets users connect you Full-text search and semantic understanding help users and AI tools find relevant information quickly. Search on your docs understands user intent rather than just matching keywords. -If a user encounters a 404 error, your site suggests related pages to help them find what they're looking for. No configuration required. - ### Structured content Your MDX pages generate semantic HTML with proper heading hierarchies, which makes it easy for AI tools to understand and reference your content. Every page is available as Markdown by appending `.md` to the page's URL. @@ -43,7 +37,7 @@ Select any of the following cards for more information. Add a menu to pages that lets users query AI tools, connect to your MCP server, and copy pages as context with one click. - Make your users aware of your MCP server and how to connect to it. + Your site has a hosted MCP server that lets users connect your docs directly to their AI tools. Make your users aware of your MCP server and how to connect to it. Configure [Claude Code](/guides/claude-code), [Cursor](/guides/cursor), or [Windsurf](/guides/windsurf) to help write, review and update your docs. From 88e6f5ff160ceede8efff062846d7af6c70520b8 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 26 Sep 2025 14:50:46 -0700 Subject: [PATCH 14/43] =?UTF-8?q?=F0=9F=92=85?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ai-native.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ai-native.mdx b/ai-native.mdx index 76a568712..b715db730 100644 --- a/ai-native.mdx +++ b/ai-native.mdx @@ -4,7 +4,7 @@ description: "Learn how AI enhances reading, writing, and distributing your docs icon: "cpu" --- -When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. These AI-native features use the content in your docs to improve the experience of reading, writing, and distributing your docs. +When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. These AI-native features analyze your docs to improve the experience of reading, writing, and distributing your docs. ## What makes your docs AI-native From 95c6017f1366a02d9163fe875d11951291220d3f Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 26 Sep 2025 15:39:04 -0700 Subject: [PATCH 15/43] move guides above API reference --- docs.json | 39 ++++++++++++++++++++++----------------- 1 file changed, 22 insertions(+), 17 deletions(-) diff --git a/docs.json b/docs.json index b65fd3b9d..b6bbe104b 100644 --- a/docs.json +++ b/docs.json @@ -108,7 +108,6 @@ "pages": [ "api-playground/overview", "api-playground/openapi-setup", - "api-playground/migrating-from-mdx", { "group": "Customization", "pages": [ @@ -321,43 +320,49 @@ ] }, { - "tab": "API Reference", + "tab": "Guides", "groups": [ { - "group": "API Reference", - "pages": ["api-reference/introduction"] + "group": "AI", + "pages": [ + "guides/geo" + ] }, { - "group": "Admin", + "group": "API docs", "pages": [ - "api-reference/update/trigger", - "api-reference/update/status" + "api-playground/migrating-from-mdx" ] }, { - "group": "Assistant", + "group": "Git", "pages": [ - "api-reference/assistant/create-assistant-message", - "api-reference/assistant/search" + "editor/git-concepts", + "editor/branches", + "editor/content-management" ] } ] }, { - "tab": "Guides", + "tab": "API Reference", "groups": [ { - "group": "AI", + "group": "API Reference", + "pages": ["api-reference/introduction"] + }, + { + "group": "Admin", "pages": [ - "guides/geo" + "api-reference/update/trigger", + "api-reference/update/status" ] }, { - "group": "Git", + "group": "Assistant", "pages": [ - "editor/git-concepts", - "editor/branches", - "editor/content-management" + "api-reference/assistant/create-assistant-message", + "api-reference/assistant/search" ] } ] From 536cb8aca7c8125d56feaf1bd450300c49f934f4 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 26 Sep 2025 15:49:54 -0700 Subject: [PATCH 16/43] remove CLI sidebarTitle --- installation.mdx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/installation.mdx b/installation.mdx index 69a05574f..29beb15ec 100644 --- a/installation.mdx +++ b/installation.mdx @@ -1,6 +1,5 @@ --- -title: "CLI installation" -sidebarTitle: "Installation" +title: "CLI setup" description: "Install the CLI to preview and develop your docs locally" icon: "terminal" --- From 5136178e58af43d8fdb2152deb4332aea97fdd86 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 26 Sep 2025 16:00:52 -0700 Subject: [PATCH 17/43] update organization --- docs.json | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/docs.json b/docs.json index b6bbe104b..53974e414 100644 --- a/docs.json +++ b/docs.json @@ -23,35 +23,36 @@ "pages": [ "index", "quickstart", + "ai-native", "installation", { "group": "Visual editor", "icon": "mouse-pointer-2", "pages": [ "editor/getting-started", + "editor/content-management", "editor/publishing", "editor/keyboard-shortcuts", "editor/troubleshooting" ] }, - "ai-native", "guides/migration" ] }, { "group": "Organize", "pages": [ - "pages", - "navigation", "settings", + "navigation", + "pages", "guides/hidden-pages" ] }, { "group": "Customize", "pages": [ - "themes", "settings/custom-domain", + "themes", "settings/custom-scripts", "react-components", { @@ -74,6 +75,7 @@ "text", "code", "image-embeds", + "components/files", "list-table", { "group": "Components", @@ -99,8 +101,6 @@ "components/update" ] }, - "reusable-snippets", - "settings/broken-links", { "group": "API playground", "icon": "play", @@ -134,6 +134,8 @@ "api-playground/troubleshooting" ] }, + "reusable-snippets", + "settings/broken-links", "guides/changelogs" ] }, @@ -180,8 +182,7 @@ "pages": [ "analytics/overview", "analytics/feedback", - "analytics/search", - "analytics/improving-docs" + "analytics/search" ] }, "settings/seo", @@ -189,9 +190,6 @@ "group": "Integrations", "icon": "folder-code", "pages": [ - "guides/claude-code", - "guides/cursor", - "guides/windsurf", { "group": "Analytics", "pages": [ @@ -325,7 +323,10 @@ { "group": "AI", "pages": [ - "guides/geo" + "guides/geo", + "guides/claude-code", + "guides/cursor", + "guides/windsurf" ] }, { @@ -334,12 +335,17 @@ "api-playground/migrating-from-mdx" ] }, + { + "group": "Analytics", + "pages": [ + "analytics/improving-docs" + ] + }, { "group": "Git", "pages": [ "editor/git-concepts", - "editor/branches", - "editor/content-management" + "editor/branches" ] } ] From 4a4a4a3dd72c3a78121e079b9ec1eab5414f45f5 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 26 Sep 2025 16:02:09 -0700 Subject: [PATCH 18/43] remove tags --- components/callouts.mdx | 1 - components/steps.mdx | 1 - docs.json | 1 - 3 files changed, 3 deletions(-) diff --git a/components/callouts.mdx b/components/callouts.mdx index bd5e41e4d..af34a3283 100644 --- a/components/callouts.mdx +++ b/components/callouts.mdx @@ -2,7 +2,6 @@ title: 'Callouts' description: 'Use callouts to add eye-catching context to your content' icon: 'info' -tag: "AI-optimized" --- Callouts can be styled as a Note, Warning, Info, Tip, Check, Danger, or create your own callout: diff --git a/components/steps.mdx b/components/steps.mdx index e0581533d..3f5b1ba1e 100644 --- a/components/steps.mdx +++ b/components/steps.mdx @@ -2,7 +2,6 @@ title: "Steps" description: "Sequence content using the Steps component" icon: "list-todo" -tag: "AI-optimized" --- import IconsOptional from "/snippets/icons-optional.mdx"; diff --git a/docs.json b/docs.json index 53974e414..80cf2d735 100644 --- a/docs.json +++ b/docs.json @@ -104,7 +104,6 @@ { "group": "API playground", "icon": "play", - "tag": "Popular", "pages": [ "api-playground/overview", "api-playground/openapi-setup", From 1f4762c9bd91f363500be8812a053522a3ee1eba Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 26 Sep 2025 16:04:02 -0700 Subject: [PATCH 19/43] remove guides icons --- api-playground/migrating-from-mdx.mdx | 1 - guides/claude-code.mdx | 1 - guides/cursor.mdx | 1 - guides/geo.mdx | 1 - guides/windsurf.mdx | 1 - 5 files changed, 5 deletions(-) diff --git a/api-playground/migrating-from-mdx.mdx b/api-playground/migrating-from-mdx.mdx index 69a7fe229..8490584e1 100644 --- a/api-playground/migrating-from-mdx.mdx +++ b/api-playground/migrating-from-mdx.mdx @@ -2,7 +2,6 @@ title: "Migrating MDX API pages to OpenAPI navigation" sidebarTitle: "Migrating from MDX" description: "Update from individual MDX endpoint pages to automated OpenAPI generation with flexible navigation" -icon: "arrow-big-right-dash" --- If you are currently using individual `MDX` pages for your API endpoints, you can migrate to autogenerating pages from your OpenAPI specification while retaining the customizability of individual pages. This can help you reduce the number of files you need to maintain and improve the consistency of your API documentation. diff --git a/guides/claude-code.mdx b/guides/claude-code.mdx index fb9efe8da..6c0565558 100644 --- a/guides/claude-code.mdx +++ b/guides/claude-code.mdx @@ -1,7 +1,6 @@ --- title: "Claude Code" description: "Configure Claude Code to help write, review, and update your docs" -icon: "asterisk" --- Claude Code is an agentic command line tool that can help you maintain your documentation. It can write new content, review existing pages, and keep docs up to date. diff --git a/guides/cursor.mdx b/guides/cursor.mdx index 862c1441f..01e03813e 100644 --- a/guides/cursor.mdx +++ b/guides/cursor.mdx @@ -1,7 +1,6 @@ --- title: "Cursor" description: "Configure Cursor to be your writing assistant" -icon: "box" --- Transform Cursor into a documentation expert that knows your components, style guide, and best practices. diff --git a/guides/geo.mdx b/guides/geo.mdx index d4294ad19..cf2d05f16 100644 --- a/guides/geo.mdx +++ b/guides/geo.mdx @@ -2,7 +2,6 @@ title: "GEO guide: Optimize docs for AI search and answer engines" sidebarTitle: "GEO" description: "Make your documentation more discoverable and cited more frequently by AI tools" -icon: "cpu" --- Optimize your documentation for both traditional search engines and AI-powered answer engines like ChatGPT, Perplexity, and Google AI Overviews. diff --git a/guides/windsurf.mdx b/guides/windsurf.mdx index ed2d80814..e00fcdd38 100644 --- a/guides/windsurf.mdx +++ b/guides/windsurf.mdx @@ -1,7 +1,6 @@ --- title: "Windsurf" description: "Configure Windsurf to be your writing assistant" -icon: "waves" --- Transform Windsurf into a documentation expert that understands your style guide, components, and project context through workspace rules and memories. From 43ddc1b834ebb56c82c08e5bcb6869e8956c9a4e Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 29 Sep 2025 17:17:02 -0700 Subject: [PATCH 20/43] Update ai-native.mdx --- ai-native.mdx | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/ai-native.mdx b/ai-native.mdx index b715db730..844ddd8f3 100644 --- a/ai-native.mdx +++ b/ai-native.mdx @@ -4,28 +4,27 @@ description: "Learn how AI enhances reading, writing, and distributing your docs icon: "cpu" --- -When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. These AI-native features analyze your docs to improve the experience of reading, writing, and distributing your docs. +When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. These AI-native features analyze your docs to improve the experience of reading, writing, and discovering your docs. ## What makes your docs AI-native -### Content suggestions -Users can chat with the assistant to get answers and links to relevant pages to guide them through using your product. Embed the assistant into custom apps with the [API](api-reference/assistant/create-assistant-message). +### Reading -If a user encounters a 404 error, your site suggests related pages to help them find what they're looking for. No configuration required. +In addition to reading individual pages, users can chat with the [assistant](/ai/assistant) in your docs for immediate answers to their questions and links to relevant content. The assistant helps guide people through your product with context from your docs, so people receive accurate information. Embed the assistant into custom apps with the [API](api-reference/assistant/create-assistant-message) to extend where users can access your docs. -### Search-optimized -Mintlify automatically hosts `llms.txt` and `llms-full.txt` files for your docs. These files are an industry standard that help LLMs index content. AI tools use these files to process the structure of your documentation and find content relevant to user queries. +### Writing -Mintlify also hosts an MCP server for your docs site that lets users connect your docs directly to their AI tools so that they have up to date information about your product directly where they want it. +Update content with + +### Discovering -Full-text search and semantic understanding help users and AI tools find relevant information quickly. Search on your docs understands user intent rather than just matching keywords. +Mintlify automatically hosts `llms.txt` and `llms-full.txt` files for your docs. These industry standard files help LLMs index your docs, process the structure of your content efficiently, and respond with relevant information to user queries. -### Structured content -Your MDX pages generate semantic HTML with proper heading hierarchies, which makes it easy for AI tools to understand and reference your content. Every page is available as Markdown by appending `.md` to the page's URL. +Mintlify also hosts an MCP server for your docs site that lets users connect your docs directly to their AI tools so that they have up to date information about your product directly where they want it. -Page frontmatter—like titles, descriptions, and tags—provides context that helps AI tools understand the purpose and scope of each page. +Full-text search and semantic understanding help users and AI tools find relevant information quickly. Search on your docs understands user intent rather than just matching keywords. And if a user encounters a 404 error, your site suggests related pages to help them find what they're looking for. No configuration required. -## Enable additional AI features +## Enable AI features Select any of the following cards for more information. From f9fdf498e31d4fb3c1b006215383d0a1c32f8d5c Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 29 Sep 2025 17:31:09 -0700 Subject: [PATCH 21/43] Update ai-native.mdx --- ai-native.mdx | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/ai-native.mdx b/ai-native.mdx index 844ddd8f3..d1852e27f 100644 --- a/ai-native.mdx +++ b/ai-native.mdx @@ -1,10 +1,10 @@ --- title: "AI-native docs" -description: "Learn how AI enhances reading, writing, and distributing your docs" +description: "Learn how AI enhances reading, writing, and discovering your docs" icon: "cpu" --- -When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. These AI-native features analyze your docs to improve the experience of reading, writing, and discovering your docs. +When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. Your content provides the context for these AI-native features to improve the experiences of reading, writing, and discovering your docs. ## What makes your docs AI-native @@ -14,7 +14,7 @@ In addition to reading individual pages, users can chat with the [assistant](/ai ### Writing -Update content with +The [agent](/ai/agent) helps you write and maintain documentation. It creates pull requests with proposed changes based on your prompts, pull requests, and Slack threads. Add the agent to your Slack workspace so that anyone on your team can help maintain your docs by chatting with the agent. Or embed the agent into custom apps via the [API](/api-reference/agent/create-agent-job). ### Discovering @@ -32,6 +32,9 @@ Select any of the following cards for more information. Configure the assistant to search external sites or direct people to your support team if it can't answer their questions. + + Add the agent to your Slack workspace or embed it into custom apps to have it help write and update your documentation. + Add a menu to pages that lets users query AI tools, connect to your MCP server, and copy pages as context with one click. From cb0cd89ecec60e515451a976f45405a5399f4214 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 29 Sep 2025 17:37:59 -0700 Subject: [PATCH 22/43] copyedits --- ai-native.mdx | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/ai-native.mdx b/ai-native.mdx index d1852e27f..22e2dc5c8 100644 --- a/ai-native.mdx +++ b/ai-native.mdx @@ -10,17 +10,19 @@ When you host your documentation on Mintlify, built-in AI features help your use ### Reading -In addition to reading individual pages, users can chat with the [assistant](/ai/assistant) in your docs for immediate answers to their questions and links to relevant content. The assistant helps guide people through your product with context from your docs, so people receive accurate information. Embed the assistant into custom apps with the [API](api-reference/assistant/create-assistant-message) to extend where users can access your docs. +In addition to reading individual pages, users can chat with the [assistant](/ai/assistant) in your docs for immediate answers to their questions and links to relevant content. The assistant helps guide users through your product with accurate information from your docs. Embed the assistant into custom apps with the [API](api-reference/assistant/create-assistant-message) to extend where users can access your docs. ### Writing The [agent](/ai/agent) helps you write and maintain documentation. It creates pull requests with proposed changes based on your prompts, pull requests, and Slack threads. Add the agent to your Slack workspace so that anyone on your team can help maintain your docs by chatting with the agent. Or embed the agent into custom apps via the [API](/api-reference/agent/create-agent-job). +Configure popular tools like [Cursor](/guides/cursor), [Claude Code](/guides/claude-code), and [Windsurf](/guides/windsurf) to reference the Mintlify schema, your style guide, and best practices. + ### Discovering -Mintlify automatically hosts `llms.txt` and `llms-full.txt` files for your docs. These industry standard files help LLMs index your docs, process the structure of your content efficiently, and respond with relevant information to user queries. +Mintlify automatically hosts `llms.txt` and `llms-full.txt` files for your docs. These industry-standard files help LLMs index your docs, process the structure of your content efficiently, and respond with relevant information to user queries. -Mintlify also hosts an MCP server for your docs site that lets users connect your docs directly to their AI tools so that they have up to date information about your product directly where they want it. +Your docs site also hosts an MCP server that lets users connect your docs directly to their AI tools for up to date information about your product directly where they want it. Full-text search and semantic understanding help users and AI tools find relevant information quickly. Search on your docs understands user intent rather than just matching keywords. And if a user encounters a 404 error, your site suggests related pages to help them find what they're looking for. No configuration required. From 355c5cbf0af414741961fe298210672fb9608ce1 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 29 Sep 2025 17:40:40 -0700 Subject: [PATCH 23/43] =?UTF-8?q?=F0=9F=92=85?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ai-native.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/ai-native.mdx b/ai-native.mdx index 22e2dc5c8..3950b9d77 100644 --- a/ai-native.mdx +++ b/ai-native.mdx @@ -20,7 +20,9 @@ Configure popular tools like [Cursor](/guides/cursor), [Claude Code](/guides/cla ### Discovering -Mintlify automatically hosts `llms.txt` and `llms-full.txt` files for your docs. These industry-standard files help LLMs index your docs, process the structure of your content efficiently, and respond with relevant information to user queries. +Your site is automatically optimized for AI tools and search engines to help users discover your docs. Your MDX pages generate semantic HTML with proper heading hierarchies and metadata, which helps AI tools process your content. Every page is also available as Markdown by appending `.md` to the URL. + +Mintlify hosts `llms.txt` and `llms-full.txt` files for your docs. These industry-standard files help LLMs index your docs, process the structure of your content efficiently, and respond with relevant information to user queries. Your docs site also hosts an MCP server that lets users connect your docs directly to their AI tools for up to date information about your product directly where they want it. From 33bd18d6b63bcb232bc1d79416e20e6478bcf424 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 29 Sep 2025 17:41:41 -0700 Subject: [PATCH 24/43] even number of cards --- ai-native.mdx | 3 --- 1 file changed, 3 deletions(-) diff --git a/ai-native.mdx b/ai-native.mdx index 3950b9d77..9064f2a77 100644 --- a/ai-native.mdx +++ b/ai-native.mdx @@ -45,7 +45,4 @@ Select any of the following cards for more information. Your site has a hosted MCP server that lets users connect your docs directly to their AI tools. Make your users aware of your MCP server and how to connect to it. - - Configure [Claude Code](/guides/claude-code), [Cursor](/guides/cursor), or [Windsurf](/guides/windsurf) to help write, review and update your docs. - From 450e9e2db2f16e5a1934b7e49de29eaac5901723 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 30 Sep 2025 11:14:14 -0700 Subject: [PATCH 25/43] update discovering section --- ai-native.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ai-native.mdx b/ai-native.mdx index 9064f2a77..be67a293b 100644 --- a/ai-native.mdx +++ b/ai-native.mdx @@ -20,9 +20,9 @@ Configure popular tools like [Cursor](/guides/cursor), [Claude Code](/guides/cla ### Discovering -Your site is automatically optimized for AI tools and search engines to help users discover your docs. Your MDX pages generate semantic HTML with proper heading hierarchies and metadata, which helps AI tools process your content. Every page is also available as Markdown by appending `.md` to the URL. +Your site is automatically optimized for AI tools and search engines to help users discover your docs. All pages are sent as Markdown to AI agents instead of HTML, which helps these tools process your content faster and use fewer tokens. Every page is also available to view as Markdown by appending `.md` to the URL. -Mintlify hosts `llms.txt` and `llms-full.txt` files for your docs. These industry-standard files help LLMs index your docs, process the structure of your content efficiently, and respond with relevant information to user queries. +Mintlify hosts `llms.txt` and `llms-full.txt` files for your docs. These industry-standard files help LLMs index your docs and respond efficiently with relevant information to user queries. Your docs site also hosts an MCP server that lets users connect your docs directly to their AI tools for up to date information about your product directly where they want it. From ee5045310ee052a1e3abbf0bb99fb2cbb62f61b9 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 30 Sep 2025 15:54:48 -0700 Subject: [PATCH 26/43] remove components tab --- docs.json | 77 ------------------------------------------------------- 1 file changed, 77 deletions(-) diff --git a/docs.json b/docs.json index 4d1f66133..0f7c6a85a 100644 --- a/docs.json +++ b/docs.json @@ -240,83 +240,6 @@ } ] }, - { - "tab": "Components", - "menu": [ - { - "item": "Accordions", - "pages": ["components/accordions"] - }, - { - "item": "Banner", - "pages": ["components/banner"] - }, - { - "item": "Callouts", - "pages": ["components/callouts"] - }, - { - "item": "Cards", - "pages": ["components/cards"] - }, - { - "item": "Code Groups", - "pages": ["components/code-groups"] - }, - { - "item": "Columns", - "pages": ["components/columns"] - }, - { - "item": "Examples", - "pages": ["components/examples"] - }, - { - "item": "Expandables", - "pages": ["components/expandables"] - }, - { - "item": "Fields", - "pages": ["components/fields"] - }, - { - "item": "Frames", - "pages": ["components/frames"] - }, - { - "item": "Icons", - "pages": ["components/icons"] - }, - { - "item": "Mermaid Diagrams", - "pages": ["components/mermaid-diagrams"] - }, - { - "item": "Panel", - "pages": ["components/panel"] - }, - { - "item": "Response fields", - "pages": ["components/responses"] - }, - { - "item": "Steps", - "pages": ["components/steps"] - }, - { - "item": "Tabs", - "pages": ["components/tabs"] - }, - { - "item": "Tooltips", - "pages": ["components/tooltips"] - }, - { - "item": "Update", - "pages": ["components/update"] - } - ] - }, { "tab": "Guides", "groups": [ From 24520bb8689b9bf8558878cf29ba7653c2ef8e58 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 30 Sep 2025 16:04:05 -0700 Subject: [PATCH 27/43] remove icons --- ai-native.mdx | 1 - ai/agent.mdx | 1 - ai/contextual-menu.mdx | 1 - ai/llmstxt.mdx | 1 - ai/markdown-export.mdx | 1 - ai/model-context-protocol.mdx | 1 - ai/slack-app.mdx | 1 - api-playground/openapi-setup.mdx | 1 - api-playground/overview.mdx | 1 - api-playground/troubleshooting.mdx | 1 - api-reference/introduction.mdx | 1 - authentication-personalization/authentication-setup.mdx | 1 - authentication-personalization/overview.mdx | 1 - authentication-personalization/personalization-setup.mdx | 1 - code.mdx | 1 - components/banner.mdx | 1 - components/callouts.mdx | 1 - components/cards.mdx | 1 - components/code-groups.mdx | 1 - components/columns.mdx | 1 - components/examples.mdx | 1 - components/expandables.mdx | 1 - components/fields.mdx | 1 - components/files.mdx | 1 - components/frames.mdx | 1 - components/icons.mdx | 1 - components/mermaid-diagrams.mdx | 1 - components/panel.mdx | 1 - components/steps.mdx | 1 - components/tabs.mdx | 1 - components/tooltips.mdx | 1 - components/update.mdx | 1 - contact-support.mdx | 1 - docs.json | 8 -------- guides/assistant.mdx | 1 - guides/changelogs.mdx | 1 - guides/deployments.mdx | 1 - guides/hidden-page-example.mdx | 1 - guides/hidden-pages.mdx | 1 - guides/migration.mdx | 1 - guides/monorepo.mdx | 1 - image-embeds.mdx | 1 - index.mdx | 1 - installation.mdx | 1 - list-table.mdx | 1 - navigation.mdx | 1 - pages.mdx | 1 - quickstart.mdx | 1 - react-components.mdx | 1 - reusable-snippets.mdx | 1 - settings.mdx | 1 - settings/broken-links.mdx | 1 - settings/ci.mdx | 1 - settings/custom-404-page.mdx | 1 - settings/custom-domain.mdx | 1 - settings/custom-scripts.mdx | 1 - settings/github.mdx | 1 - settings/gitlab.mdx | 1 - settings/preview-deployments.mdx | 1 - settings/seo.mdx | 1 - text.mdx | 1 - themes.mdx | 1 - 62 files changed, 69 deletions(-) diff --git a/ai-native.mdx b/ai-native.mdx index be67a293b..a65d56e74 100644 --- a/ai-native.mdx +++ b/ai-native.mdx @@ -1,7 +1,6 @@ --- title: "AI-native docs" description: "Learn how AI enhances reading, writing, and discovering your docs" -icon: "cpu" --- When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. Your content provides the context for these AI-native features to improve the experiences of reading, writing, and discovering your docs. diff --git a/ai/agent.mdx b/ai/agent.mdx index 2de92f597..012bd1d55 100644 --- a/ai/agent.mdx +++ b/ai/agent.mdx @@ -1,7 +1,6 @@ --- title: "Agent" description: "The agent helps you write and maintain documentation" -icon: "pen-line" --- diff --git a/ai/contextual-menu.mdx b/ai/contextual-menu.mdx index f7621bbb6..9b0af219f 100644 --- a/ai/contextual-menu.mdx +++ b/ai/contextual-menu.mdx @@ -1,7 +1,6 @@ --- title: "Contextual menu" description: "Add one-click AI integrations to your docs" -icon: "square-menu" --- import { PreviewButton } from "/snippets/previewbutton.jsx" diff --git a/ai/llmstxt.mdx b/ai/llmstxt.mdx index ed4363e44..89e99b96c 100644 --- a/ai/llmstxt.mdx +++ b/ai/llmstxt.mdx @@ -1,7 +1,6 @@ --- title: "llms.txt" description: "Make your content easier for LLMs to read and index" -icon: "file-code" --- import { PreviewButton } from "/snippets/previewbutton.jsx" diff --git a/ai/markdown-export.mdx b/ai/markdown-export.mdx index 61a63859f..344c8d31a 100644 --- a/ai/markdown-export.mdx +++ b/ai/markdown-export.mdx @@ -1,7 +1,6 @@ --- title: "Markdown export" description: "Quickly get Markdown versions of pages" -icon: "file-text" --- import { PreviewButton } from "/snippets/previewbutton.jsx" diff --git a/ai/model-context-protocol.mdx b/ai/model-context-protocol.mdx index a359b62fa..d32f0a993 100644 --- a/ai/model-context-protocol.mdx +++ b/ai/model-context-protocol.mdx @@ -1,7 +1,6 @@ --- title: "Model Context Protocol" description: "Let users access your docs and APIs through their favorite AI tools" -icon: "audio-waveform" keywords: ["mcp"] --- diff --git a/ai/slack-app.mdx b/ai/slack-app.mdx index b63a860e9..16818a12f 100644 --- a/ai/slack-app.mdx +++ b/ai/slack-app.mdx @@ -1,7 +1,6 @@ --- title: "Slack app" description: "Add a bot that searches your docs to answer questions in your Slack workspace" -icon: "slack" --- diff --git a/api-playground/openapi-setup.mdx b/api-playground/openapi-setup.mdx index f9235eef2..3c583b1c6 100644 --- a/api-playground/openapi-setup.mdx +++ b/api-playground/openapi-setup.mdx @@ -1,7 +1,6 @@ --- title: "OpenAPI setup" description: "Reference OpenAPI endpoints in your docs pages" -icon: "file-json" --- OpenAPI is a specification for describing APIs. Mintlify supports OpenAPI 3.0+ documents to generate interactive API documentation and keep it up to date. diff --git a/api-playground/overview.mdx b/api-playground/overview.mdx index aa0ada383..5480a8f4b 100644 --- a/api-playground/overview.mdx +++ b/api-playground/overview.mdx @@ -1,7 +1,6 @@ --- title: "Playground" description: "Enable users to interact with your API" -icon: "play" --- ## Overview diff --git a/api-playground/troubleshooting.mdx b/api-playground/troubleshooting.mdx index e66147844..d354cf555 100644 --- a/api-playground/troubleshooting.mdx +++ b/api-playground/troubleshooting.mdx @@ -1,7 +1,6 @@ --- title: "Troubleshooting" description: "Common issues with API References" -icon: "message-square-warning" --- If your API pages aren't displaying correctly, check these common configuration issues: diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index 2a446431d..d3602fada 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -1,7 +1,6 @@ --- title: "Introduction" description: "Trigger updates, embed AI assistant, and more" -icon: "book-open" --- The Mintlify REST API enables you to programmatically interact with your documentation, trigger updates, and embed AI-powered chat experiences. diff --git a/authentication-personalization/authentication-setup.mdx b/authentication-personalization/authentication-setup.mdx index 8693e5e40..308968ebb 100644 --- a/authentication-personalization/authentication-setup.mdx +++ b/authentication-personalization/authentication-setup.mdx @@ -1,7 +1,6 @@ --- title: "Authentication setup" description: "Control the privacy of your docs by authenticating users" -icon: "file-lock" keywords: ['auth'] --- diff --git a/authentication-personalization/overview.mdx b/authentication-personalization/overview.mdx index 296730c14..5ec8f7f6e 100644 --- a/authentication-personalization/overview.mdx +++ b/authentication-personalization/overview.mdx @@ -1,7 +1,6 @@ --- title: "Overview" description: "Control who sees your documentation and customize their experience" -icon: "badge-info" keywords: ["auth"] --- diff --git a/authentication-personalization/personalization-setup.mdx b/authentication-personalization/personalization-setup.mdx index af9fcfbcc..71826190f 100644 --- a/authentication-personalization/personalization-setup.mdx +++ b/authentication-personalization/personalization-setup.mdx @@ -1,7 +1,6 @@ --- title: "Personalization setup" description: "Let users log in for customized documentation experiences" -icon: "user-cog" --- Personalization customizes your documentation for each user when they are logged in. For example, you can prefill their API keys, show content specific to their plan or role, or hide sections they don't need access to. diff --git a/code.mdx b/code.mdx index c89d9da7c..e0b6832e5 100644 --- a/code.mdx +++ b/code.mdx @@ -1,7 +1,6 @@ --- title: "Code" description: "Display inline code and code blocks" -icon: "code" --- ## Adding code samples diff --git a/components/banner.mdx b/components/banner.mdx index 951a63ace..83267f3cf 100644 --- a/components/banner.mdx +++ b/components/banner.mdx @@ -1,7 +1,6 @@ --- title: "Banner" description: "Add a banner to display important site-wide announcements and notifications" -icon: "layout-panel-top" --- Use banners to display important announcements, updates, or notifications across your entire documentation site. Banners appear at the top of every page, support Markdown formatting, and can be made dismissible. diff --git a/components/callouts.mdx b/components/callouts.mdx index af34a3283..f2fdcea0e 100644 --- a/components/callouts.mdx +++ b/components/callouts.mdx @@ -1,7 +1,6 @@ --- title: 'Callouts' description: 'Use callouts to add eye-catching context to your content' -icon: 'info' --- Callouts can be styled as a Note, Warning, Info, Tip, Check, Danger, or create your own callout: diff --git a/components/cards.mdx b/components/cards.mdx index db1151f79..88297a572 100644 --- a/components/cards.mdx +++ b/components/cards.mdx @@ -1,7 +1,6 @@ --- title: "Cards" description: "Highlight main points or links with customizable layouts and icons" -icon: "square-mouse-pointer" --- import IconsOptional from "/snippets/icons-optional.mdx"; diff --git a/components/code-groups.mdx b/components/code-groups.mdx index a4694711e..55f0f6bcf 100644 --- a/components/code-groups.mdx +++ b/components/code-groups.mdx @@ -1,7 +1,6 @@ --- title: "Code groups" description: "Display multiple code examples in one component" -icon: "group" --- Use the `CodeGroup` component to display multiple code blocks in a tabbed interface, allowing users to compare implementations across different programming languages or see alternative approaches for the same task. diff --git a/components/columns.mdx b/components/columns.mdx index 0752c38a4..839528631 100644 --- a/components/columns.mdx +++ b/components/columns.mdx @@ -1,7 +1,6 @@ --- title: 'Columns' description: 'Show cards side by side in a grid format' -icon: 'columns-2' keywords: ['card groups'] --- diff --git a/components/examples.mdx b/components/examples.mdx index e0481c515..fd2a4aab4 100644 --- a/components/examples.mdx +++ b/components/examples.mdx @@ -1,7 +1,6 @@ --- title: "Examples" description: "Display code blocks in the right sidebar on desktop devices" -icon: 'between-horizontal-start' --- The `` and `` components display code blocks in the right sidebar to create a two-column layout that keeps examples visible while users scroll through your content. These components are designed for API documentation, but they work on all pages. diff --git a/components/expandables.mdx b/components/expandables.mdx index 45f8a91e6..583ad5608 100644 --- a/components/expandables.mdx +++ b/components/expandables.mdx @@ -1,7 +1,6 @@ --- title: "Expandables" description: "Toggle to display nested properties" -icon: "list-tree" --- Use expandables to show and hide nested content within response fields. Expandables are particularly useful for displaying complex object properties in API documentation. diff --git a/components/fields.mdx b/components/fields.mdx index ac86c323f..32fdb435d 100644 --- a/components/fields.mdx +++ b/components/fields.mdx @@ -1,7 +1,6 @@ --- title: "Fields" description: "Set parameters for your API or SDK references" -icon: "letter-text" --- Use fields to document API parameters and responses. There are two types of fields: parameter fields and response fields. diff --git a/components/files.mdx b/components/files.mdx index e3956e0a2..6fa0151f3 100644 --- a/components/files.mdx +++ b/components/files.mdx @@ -1,7 +1,6 @@ --- title: "Files" description: "Serve static assets from your documentation" -icon: "folder" --- 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`. diff --git a/components/frames.mdx b/components/frames.mdx index 3ff1c4438..0b5efec11 100644 --- a/components/frames.mdx +++ b/components/frames.mdx @@ -1,7 +1,6 @@ --- title: "Frames" description: "Wrap images or other components in a container" -icon: "frame" --- Use frames to display images, diagrams, or other visual content with consistent styling and optional captions. Frames center content and provide visual separation from surrounding text. diff --git a/components/icons.mdx b/components/icons.mdx index 58c234a5b..709e510a1 100644 --- a/components/icons.mdx +++ b/components/icons.mdx @@ -1,7 +1,6 @@ --- title: "Icons" description: "Use icons from popular icon libraries" -icon: "flag" --- import IconsRequired from "/snippets/icons-required.mdx"; diff --git a/components/mermaid-diagrams.mdx b/components/mermaid-diagrams.mdx index bca2c8440..5fdc9a41d 100644 --- a/components/mermaid-diagrams.mdx +++ b/components/mermaid-diagrams.mdx @@ -1,7 +1,6 @@ --- title: "Mermaid" description: "Display diagrams using Mermaid" -icon: "waypoints" --- [Mermaid](https://mermaid.js.org/) lets you build flowcharts, sequence diagrams, Gantt charts, and other diagrams using text and code. diff --git a/components/panel.mdx b/components/panel.mdx index 6a9febc55..4ecace39e 100644 --- a/components/panel.mdx +++ b/components/panel.mdx @@ -1,7 +1,6 @@ --- title: 'Panel' description: 'Specify the content of the right side panel' -icon: 'panel-right' --- You can use the `` component to customize the right side panel of a page with any components that you want. diff --git a/components/steps.mdx b/components/steps.mdx index 3f5b1ba1e..5961c516e 100644 --- a/components/steps.mdx +++ b/components/steps.mdx @@ -1,7 +1,6 @@ --- title: "Steps" description: "Sequence content using the Steps component" -icon: "list-todo" --- import IconsOptional from "/snippets/icons-optional.mdx"; diff --git a/components/tabs.mdx b/components/tabs.mdx index 7aa270a1e..5786a8143 100644 --- a/components/tabs.mdx +++ b/components/tabs.mdx @@ -1,7 +1,6 @@ --- title: "Tabs" description: "Toggle content using the Tabs component" -icon: "panel-top" --- Use tabs to organize content into multiple panels that users can switch between. You can add any number of tabs and include other components inside each tab. diff --git a/components/tooltips.mdx b/components/tooltips.mdx index c48fb94b7..24759984c 100644 --- a/components/tooltips.mdx +++ b/components/tooltips.mdx @@ -1,7 +1,6 @@ --- title: "Tooltips" description: "Show a definition when you hover over text" -icon: "message-square" --- Use tooltips to provide additional context or definitions when a user hovers over a string of text. Tooltips can include optional call-to-action links. diff --git a/components/update.mdx b/components/update.mdx index 6e13f200c..d389e26d6 100644 --- a/components/update.mdx +++ b/components/update.mdx @@ -1,7 +1,6 @@ --- title: "Update" description: "Keep track of changes and updates" -icon: "list-collapse" --- Use the `Update` component to display changelog entries, version updates, and release notes with consistent formatting. diff --git a/contact-support.mdx b/contact-support.mdx index 899e7a6cd..b31b482dd 100644 --- a/contact-support.mdx +++ b/contact-support.mdx @@ -1,6 +1,5 @@ --- title: "Contact support" -icon: "circle-help" description: "We're here to help you get the most out of Mintlify" --- diff --git a/docs.json b/docs.json index 0f7c6a85a..0029d207b 100644 --- a/docs.json +++ b/docs.json @@ -27,7 +27,6 @@ "installation", { "group": "Visual editor", - "icon": "mouse-pointer-2", "pages": [ "editor/getting-started", "editor/content-management", @@ -57,7 +56,6 @@ "react-components", { "group": "Dashboard access", - "icon": "gauge", "pages": [ "advanced/dashboard/sso", "advanced/dashboard/permissions", @@ -79,7 +77,6 @@ "list-table", { "group": "Components", - "icon": "blocks", "pages": [ "components/accordions", "components/banner", @@ -103,7 +100,6 @@ }, { "group": "API playground", - "icon": "play", "pages": [ "api-playground/overview", "api-playground/openapi-setup", @@ -145,7 +141,6 @@ "settings/preview-deployments", { "group": "Custom subdirectory", - "icon": "folder", "pages": [ "advanced/subpath/cloudflare", "advanced/subpath/route53-cloudfront", @@ -165,7 +160,6 @@ "pages": [ { "group": "AI", - "icon": "bot", "pages": [ "guides/assistant", "ai/agent", @@ -178,7 +172,6 @@ }, { "group": "Analytics", - "icon": "chart-line", "pages": [ "analytics/overview", "analytics/feedback", @@ -188,7 +181,6 @@ "settings/seo", { "group": "Integrations", - "icon": "folder-code", "pages": [ { "group": "Analytics", diff --git a/guides/assistant.mdx b/guides/assistant.mdx index 8c7c4bbe6..8a0931e26 100644 --- a/guides/assistant.mdx +++ b/guides/assistant.mdx @@ -1,7 +1,6 @@ --- title: "Assistant" description: "Help users succeed with your product and find answers faster" -icon: "bot" --- diff --git a/guides/changelogs.mdx b/guides/changelogs.mdx index 3b475121d..51abbc2b6 100644 --- a/guides/changelogs.mdx +++ b/guides/changelogs.mdx @@ -1,7 +1,6 @@ --- title: "Changelogs" description: "Post product updates in your docs with a subscribable RSS feed" -icon: "newspaper" --- Create a changelog for your docs by adding [Update components](/components/update) to a page. diff --git a/guides/deployments.mdx b/guides/deployments.mdx index cf382d724..a6e8ae4f3 100644 --- a/guides/deployments.mdx +++ b/guides/deployments.mdx @@ -1,7 +1,6 @@ --- title: "Deployments" description: "Troubleshoot your deployments" -icon: "boxes" --- Your documentation site automatically deploys when you push changes to your connected repository. This requires the Mintlify GitHub app to be properly installed and connected. diff --git a/guides/hidden-page-example.mdx b/guides/hidden-page-example.mdx index c8941fc23..91406a532 100644 --- a/guides/hidden-page-example.mdx +++ b/guides/hidden-page-example.mdx @@ -1,7 +1,6 @@ --- title: "Hidden page example" description: "Common use cases for hidden pages" -icon: "eye-off" --- This page is hidden! It is not included in the `docs.json` navigation so you can only access it by its URL. diff --git a/guides/hidden-pages.mdx b/guides/hidden-pages.mdx index 2c91872bb..8ec36af60 100644 --- a/guides/hidden-pages.mdx +++ b/guides/hidden-pages.mdx @@ -1,7 +1,6 @@ --- title: "Hidden pages" description: "Exclude pages from your navigation" -icon: "eye-closed" --- Hidden pages are removed from your site's navigation but remain publicly accessible to anyone who knows their URL. diff --git a/guides/migration.mdx b/guides/migration.mdx index 58a8629f3..6f43f58ca 100644 --- a/guides/migration.mdx +++ b/guides/migration.mdx @@ -1,7 +1,6 @@ --- title: "Migrations" description: "How to migrate documentation from your current platform" -icon: "import" --- This guide helps you move your existing documentation to Mintlify. Choose automated migration for supported platforms or manual migration for complete control over the process. diff --git a/guides/monorepo.mdx b/guides/monorepo.mdx index e94790d60..4aba411f3 100644 --- a/guides/monorepo.mdx +++ b/guides/monorepo.mdx @@ -1,7 +1,6 @@ --- title: "Monorepo setup" description: "Deploy your docs from a repo that contains multiple projects" -icon: "folder-git" --- Configure Mintlify to deploy documentation from a specific directory within a monorepo. This setup allows you to maintain documentation alongside your code in repositories that contain multiple projects or services. diff --git a/image-embeds.mdx b/image-embeds.mdx index 86b78b2da..78bf23dde 100644 --- a/image-embeds.mdx +++ b/image-embeds.mdx @@ -1,7 +1,6 @@ --- title: "Images and embeds" description: "Add images, videos, and iframes" -icon: "image" --- Add images, embed videos, and include interactive content with iframes to your documentation. diff --git a/index.mdx b/index.mdx index 92bfd2201..4e48f2ae4 100644 --- a/index.mdx +++ b/index.mdx @@ -1,7 +1,6 @@ --- title: "Introduction" description: "Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers." -icon: "book-open" mode: "custom" --- diff --git a/installation.mdx b/installation.mdx index 29beb15ec..ccfed3466 100644 --- a/installation.mdx +++ b/installation.mdx @@ -1,7 +1,6 @@ --- title: "CLI setup" description: "Install the CLI to preview and develop your docs locally" -icon: "terminal" --- diff --git a/settings/custom-404-page.mdx b/settings/custom-404-page.mdx index 916028a51..a25d7f412 100644 --- a/settings/custom-404-page.mdx +++ b/settings/custom-404-page.mdx @@ -1,7 +1,6 @@ --- title: "Custom 404 page" description: "Customize the title and description of your 404 error page" -icon: "file-warning" --- You can control the title and description of the 404 error page that appears when users navigate to broken or missing links. diff --git a/settings/custom-domain.mdx b/settings/custom-domain.mdx index a023398ee..bf9083bcd 100644 --- a/settings/custom-domain.mdx +++ b/settings/custom-domain.mdx @@ -1,7 +1,6 @@ --- title: "Custom domain" description: "Host your documentation at your website's custom domain" -icon: "globe" --- To set up your documentation on a custom domain, you'll need to set your desired custom domain in your Mintlify settings and configure your DNS settings on your domain provider. diff --git a/settings/custom-scripts.mdx b/settings/custom-scripts.mdx index 98dc02e76..36a12e84b 100644 --- a/settings/custom-scripts.mdx +++ b/settings/custom-scripts.mdx @@ -1,7 +1,6 @@ --- title: "Custom scripts" description: "Fully customize your documentation with custom CSS and JS" -icon: "code" --- Use CSS to style HTML elements or add custom CSS and JavaScript to fully customize the look and feel of your documentation. diff --git a/settings/github.mdx b/settings/github.mdx index 74dae45ef..6d258173c 100644 --- a/settings/github.mdx +++ b/settings/github.mdx @@ -1,7 +1,6 @@ --- title: "GitHub" description: "Sync your docs with a GitHub repo" -icon: "github" --- Mintlify uses a GitHub App to automatically sync your documentation with your GitHub repository. diff --git a/settings/gitlab.mdx b/settings/gitlab.mdx index e3144f9df..734c47ec1 100644 --- a/settings/gitlab.mdx +++ b/settings/gitlab.mdx @@ -1,7 +1,6 @@ --- title: "GitLab" description: "Sync your docs with a GitLab repo" -icon: "gitlab" --- We use access tokens and webhooks to authenticate and sync changes between GitLab and Mintlify. diff --git a/settings/preview-deployments.mdx b/settings/preview-deployments.mdx index d1697c710..eedc96322 100644 --- a/settings/preview-deployments.mdx +++ b/settings/preview-deployments.mdx @@ -1,7 +1,6 @@ --- title: "Preview deployments" description: "Preview changes to your docs in a live deployment" -icon: "scan-eye" --- diff --git a/settings/seo.mdx b/settings/seo.mdx index d344962ae..cb441250f 100644 --- a/settings/seo.mdx +++ b/settings/seo.mdx @@ -1,7 +1,6 @@ --- title: "SEO" description: "SEO best practices and meta tag configuration for better search visibility" -icon: "search" --- Mintlify automatically handles many SEO best practices, including: diff --git a/text.mdx b/text.mdx index f7f02f8ab..de8b9e386 100644 --- a/text.mdx +++ b/text.mdx @@ -1,7 +1,6 @@ --- title: "Headers and text" description: "Learn how to format text, create headers, and style content" -icon: "heading" --- ## Headers diff --git a/themes.mdx b/themes.mdx index 2b93433e4..3e8eb5083 100644 --- a/themes.mdx +++ b/themes.mdx @@ -1,7 +1,6 @@ --- title: "Themes" description: "Customize the appearance of your documentation" -icon: "paint-bucket" mode: "custom" --- From 89112bf89fae24bea7f47198b158d1b814700df6 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 30 Sep 2025 16:05:13 -0700 Subject: [PATCH 28/43] remove icon --- components/accordions.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/components/accordions.mdx b/components/accordions.mdx index 7aa0c4c8d..8e541b847 100644 --- a/components/accordions.mdx +++ b/components/accordions.mdx @@ -1,7 +1,6 @@ --- title: "Accordions" description: "Collapsible components to show and hide content" -icon: "chevron-down" --- import IconsOptional from "/snippets/icons-optional.mdx"; From 1ad2ce9f5c1d022c5e83cec9fd44bb445154ddab Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 30 Sep 2025 16:10:30 -0700 Subject: [PATCH 29/43] add group level icons --- docs.json | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs.json b/docs.json index 0029d207b..c6bcf0c64 100644 --- a/docs.json +++ b/docs.json @@ -20,6 +20,7 @@ "groups": [ { "group": "Get started", + "icon": "rocket", "pages": [ "index", "quickstart", @@ -40,6 +41,7 @@ }, { "group": "Organize", + "icon": "map", "pages": [ "settings", "navigation", @@ -49,6 +51,7 @@ }, { "group": "Customize", + "icon": "paint-bucket", "pages": [ "settings/custom-domain", "themes", @@ -69,6 +72,7 @@ }, { "group": "Write and edit", + "icon": "pen-line", "pages": [ "text", "code", @@ -136,6 +140,7 @@ }, { "group": "Deploy", + "icon": "boxes", "pages": [ "guides/deployments", "settings/preview-deployments", @@ -157,6 +162,7 @@ }, { "group": "Optimize", + "icon": "wrench", "pages": [ { "group": "AI", @@ -237,6 +243,7 @@ "groups": [ { "group": "AI", + "icon": "bot", "pages": [ "guides/geo", "guides/claude-code", @@ -246,18 +253,21 @@ }, { "group": "API docs", + "icon": "file-json", "pages": [ "api-playground/migrating-from-mdx" ] }, { "group": "Analytics", + "icon": "chart-line", "pages": [ "analytics/improving-docs" ] }, { "group": "Git", + "icon": "git-merge", "pages": [ "editor/git-concepts", "editor/branches" From f4532f7e706fc1a38af6ad263e80209f2eed7ce7 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 30 Sep 2025 16:17:09 -0700 Subject: [PATCH 30/43] update Get started group --- ai-native.mdx | 22 +++++++++++----------- docs.json | 4 ++-- installation.mdx | 2 +- guides/migration.mdx => migration.mdx | 0 4 files changed, 14 insertions(+), 14 deletions(-) rename guides/migration.mdx => migration.mdx (100%) diff --git a/ai-native.mdx b/ai-native.mdx index a65d56e74..4f5bee8b4 100644 --- a/ai-native.mdx +++ b/ai-native.mdx @@ -1,31 +1,31 @@ --- -title: "AI-native docs" -description: "Learn how AI enhances reading, writing, and discovering your docs" +title: "AI-native" +description: "Learn how AI enhances reading, writing, and discovering your documentation" --- -When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. Your content provides the context for these AI-native features to improve the experiences of reading, writing, and discovering your docs. +When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. Your content provides the context for these AI-native features to improve the experiences of reading, writing, and discovering your documentation. -## What makes your docs AI-native +## What makes your documentation AI-native ### Reading -In addition to reading individual pages, users can chat with the [assistant](/ai/assistant) in your docs for immediate answers to their questions and links to relevant content. The assistant helps guide users through your product with accurate information from your docs. Embed the assistant into custom apps with the [API](api-reference/assistant/create-assistant-message) to extend where users can access your docs. +In addition to reading individual pages, users can chat with the [assistant](/ai/assistant) in your documentation for immediate answers to their questions and links to relevant content. The assistant helps guide users through your product with accurate information from your documentation. Embed the assistant into custom apps with the [API](api-reference/assistant/create-assistant-message) to extend where users can access your documentation. ### Writing -The [agent](/ai/agent) helps you write and maintain documentation. It creates pull requests with proposed changes based on your prompts, pull requests, and Slack threads. Add the agent to your Slack workspace so that anyone on your team can help maintain your docs by chatting with the agent. Or embed the agent into custom apps via the [API](/api-reference/agent/create-agent-job). +The [agent](/ai/agent) helps you write and maintain documentation. It creates pull requests with proposed changes based on your prompts, pull requests, and Slack threads. Add the agent to your Slack workspace so that anyone on your team can help maintain your documentation by chatting with the agent. Or embed the agent into custom apps via the [API](/api-reference/agent/create-agent-job). Configure popular tools like [Cursor](/guides/cursor), [Claude Code](/guides/claude-code), and [Windsurf](/guides/windsurf) to reference the Mintlify schema, your style guide, and best practices. ### Discovering -Your site is automatically optimized for AI tools and search engines to help users discover your docs. All pages are sent as Markdown to AI agents instead of HTML, which helps these tools process your content faster and use fewer tokens. Every page is also available to view as Markdown by appending `.md` to the URL. +Your site is automatically optimized for AI tools and search engines to help users discover your documentation. All pages are sent as Markdown to AI agents instead of HTML, which helps these tools process your content faster and use fewer tokens. Every page is also available to view as Markdown by appending `.md` to the URL. -Mintlify hosts `llms.txt` and `llms-full.txt` files for your docs. These industry-standard files help LLMs index your docs and respond efficiently with relevant information to user queries. +Mintlify hosts `llms.txt` and `llms-full.txt` files for your documentation. These industry-standard files help LLMs index your documentation and respond efficiently with relevant information to user queries. -Your docs site also hosts an MCP server that lets users connect your docs directly to their AI tools for up to date information about your product directly where they want it. +Your documentation site also hosts an MCP server that lets users connect your documentation directly to their AI tools for up to date information about your product directly where they want it. -Full-text search and semantic understanding help users and AI tools find relevant information quickly. Search on your docs understands user intent rather than just matching keywords. And if a user encounters a 404 error, your site suggests related pages to help them find what they're looking for. No configuration required. +Full-text search and semantic understanding help users and AI tools find relevant information quickly. Search understands user intent rather than just matching keywords. And if a user encounters a 404 error, your site suggests related pages to help them find what they're looking for. No configuration required. ## Enable AI features @@ -42,6 +42,6 @@ Select any of the following cards for more information. Add a menu to pages that lets users query AI tools, connect to your MCP server, and copy pages as context with one click. - Your site has a hosted MCP server that lets users connect your docs directly to their AI tools. Make your users aware of your MCP server and how to connect to it. + Your site has a hosted MCP server that lets users connect your documentation directly to their AI tools. Make your users aware of your MCP server and how to connect to it. diff --git a/docs.json b/docs.json index c6bcf0c64..a60fcedd8 100644 --- a/docs.json +++ b/docs.json @@ -24,7 +24,6 @@ "pages": [ "index", "quickstart", - "ai-native", "installation", { "group": "Visual editor", @@ -36,7 +35,8 @@ "editor/troubleshooting" ] }, - "guides/migration" + "ai-native", + "migration" ] }, { diff --git a/installation.mdx b/installation.mdx index ccfed3466..0c2491407 100644 --- a/installation.mdx +++ b/installation.mdx @@ -1,5 +1,5 @@ --- -title: "CLI setup" +title: "CLI installation" description: "Install the CLI to preview and develop your docs locally" --- diff --git a/guides/migration.mdx b/migration.mdx similarity index 100% rename from guides/migration.mdx rename to migration.mdx From 903573e601799c49a2d16c42277ff39935cf5256 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 30 Sep 2025 16:19:14 -0700 Subject: [PATCH 31/43] Update organize group --- docs.json | 8 ++++---- {guides => organize}/hidden-page-example.mdx | 0 {guides => organize}/hidden-pages.mdx | 2 +- navigation.mdx => organize/navigation.mdx | 0 pages.mdx => organize/pages.mdx | 0 settings.mdx => organize/settings.mdx | 0 6 files changed, 5 insertions(+), 5 deletions(-) rename {guides => organize}/hidden-page-example.mdx (100%) rename {guides => organize}/hidden-pages.mdx (97%) rename navigation.mdx => organize/navigation.mdx (100%) rename pages.mdx => organize/pages.mdx (100%) rename settings.mdx => organize/settings.mdx (100%) diff --git a/docs.json b/docs.json index a60fcedd8..a4e1e934d 100644 --- a/docs.json +++ b/docs.json @@ -43,10 +43,10 @@ "group": "Organize", "icon": "map", "pages": [ - "settings", - "navigation", - "pages", - "guides/hidden-pages" + "organize/settings", + "organize/navigation", + "organize/pages", + "organize/hidden-pages" ] }, { diff --git a/guides/hidden-page-example.mdx b/organize/hidden-page-example.mdx similarity index 100% rename from guides/hidden-page-example.mdx rename to organize/hidden-page-example.mdx diff --git a/guides/hidden-pages.mdx b/organize/hidden-pages.mdx similarity index 97% rename from guides/hidden-pages.mdx rename to organize/hidden-pages.mdx index 8ec36af60..8a103be17 100644 --- a/guides/hidden-pages.mdx +++ b/organize/hidden-pages.mdx @@ -17,7 +17,7 @@ A page is hidden if it is not included in your `docs.json` navigation. To hide a 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`. -See an [example of a hidden page](/guides/hidden-page-example). +See an [example of a hidden page](/organize/hidden-page-example). Some navigation elements like sidebars, dropdowns, and tabs may appear empty or shift layout on hidden pages. diff --git a/navigation.mdx b/organize/navigation.mdx similarity index 100% rename from navigation.mdx rename to organize/navigation.mdx diff --git a/pages.mdx b/organize/pages.mdx similarity index 100% rename from pages.mdx rename to organize/pages.mdx diff --git a/settings.mdx b/organize/settings.mdx similarity index 100% rename from settings.mdx rename to organize/settings.mdx From a2244d412bc4e47dae92483a35ec21f08c0a3210 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 30 Sep 2025 16:37:17 -0700 Subject: [PATCH 32/43] update customize group --- {settings => customize}/custom-404-page.mdx | 0 {settings => customize}/custom-domain.mdx | 0 {settings => customize}/custom-scripts.mdx | 0 .../dashboard/permissions.mdx | 0 {advanced => customize}/dashboard/roles.mdx | 0 {advanced => customize}/dashboard/sso.mdx | 0 .../react-components.mdx | 0 themes.mdx => customize/themes.mdx | 0 docs.json | 20 +++++++++---------- 9 files changed, 10 insertions(+), 10 deletions(-) rename {settings => customize}/custom-404-page.mdx (100%) rename {settings => customize}/custom-domain.mdx (100%) rename {settings => customize}/custom-scripts.mdx (100%) rename {advanced => customize}/dashboard/permissions.mdx (100%) rename {advanced => customize}/dashboard/roles.mdx (100%) rename {advanced => customize}/dashboard/sso.mdx (100%) rename react-components.mdx => customize/react-components.mdx (100%) rename themes.mdx => customize/themes.mdx (100%) diff --git a/settings/custom-404-page.mdx b/customize/custom-404-page.mdx similarity index 100% rename from settings/custom-404-page.mdx rename to customize/custom-404-page.mdx diff --git a/settings/custom-domain.mdx b/customize/custom-domain.mdx similarity index 100% rename from settings/custom-domain.mdx rename to customize/custom-domain.mdx diff --git a/settings/custom-scripts.mdx b/customize/custom-scripts.mdx similarity index 100% rename from settings/custom-scripts.mdx rename to customize/custom-scripts.mdx diff --git a/advanced/dashboard/permissions.mdx b/customize/dashboard/permissions.mdx similarity index 100% rename from advanced/dashboard/permissions.mdx rename to customize/dashboard/permissions.mdx diff --git a/advanced/dashboard/roles.mdx b/customize/dashboard/roles.mdx similarity index 100% rename from advanced/dashboard/roles.mdx rename to customize/dashboard/roles.mdx diff --git a/advanced/dashboard/sso.mdx b/customize/dashboard/sso.mdx similarity index 100% rename from advanced/dashboard/sso.mdx rename to customize/dashboard/sso.mdx diff --git a/react-components.mdx b/customize/react-components.mdx similarity index 100% rename from react-components.mdx rename to customize/react-components.mdx diff --git a/themes.mdx b/customize/themes.mdx similarity index 100% rename from themes.mdx rename to customize/themes.mdx diff --git a/docs.json b/docs.json index a4e1e934d..f8b3ab530 100644 --- a/docs.json +++ b/docs.json @@ -53,21 +53,19 @@ "group": "Customize", "icon": "paint-bucket", "pages": [ - "settings/custom-domain", - "themes", - "settings/custom-scripts", - "react-components", + "customize/custom-domain", + "customize/themes", + "customize/custom-scripts", + "customize/react-components", { "group": "Dashboard access", "pages": [ - "advanced/dashboard/sso", - "advanced/dashboard/permissions", - "advanced/dashboard/roles" + "customize/dashboard/sso", + "customize/dashboard/permissions", + "customize/dashboard/roles" ] }, - "authentication-personalization/authentication-setup", - "authentication-personalization/personalization-setup", - "settings/custom-404-page" + "customize/custom-404-page" ] }, { @@ -154,6 +152,8 @@ "guides/csp-configuration" ] }, + "authentication-personalization/authentication-setup", + "authentication-personalization/personalization-setup", "guides/monorepo", "settings/ci", "settings/github", From 87910f798ee3a1745b0762b4bed0b52571794f43 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 30 Sep 2025 17:01:16 -0700 Subject: [PATCH 33/43] update create content group --- {settings => create}/broken-links.mdx | 0 {guides => create}/changelogs.mdx | 0 code.mdx => create/code.mdx | 2 +- {components => create}/files.mdx | 0 image-embeds.mdx => create/image-embeds.mdx | 0 list-table.mdx => create/list-table.mdx | 0 .../reusable-snippets.mdx | 0 text.mdx => create/text.mdx | 2 +- docs.json | 74 ++++++++++--------- 9 files changed, 40 insertions(+), 38 deletions(-) rename {settings => create}/broken-links.mdx (100%) rename {guides => create}/changelogs.mdx (100%) rename code.mdx => create/code.mdx (99%) rename {components => create}/files.mdx (100%) rename image-embeds.mdx => create/image-embeds.mdx (100%) rename list-table.mdx => create/list-table.mdx (100%) rename reusable-snippets.mdx => create/reusable-snippets.mdx (100%) rename text.mdx => create/text.mdx (99%) diff --git a/settings/broken-links.mdx b/create/broken-links.mdx similarity index 100% rename from settings/broken-links.mdx rename to create/broken-links.mdx diff --git a/guides/changelogs.mdx b/create/changelogs.mdx similarity index 100% rename from guides/changelogs.mdx rename to create/changelogs.mdx diff --git a/code.mdx b/create/code.mdx similarity index 99% rename from code.mdx rename to create/code.mdx index e0b6832e5..d7054c9e5 100644 --- a/code.mdx +++ b/create/code.mdx @@ -1,5 +1,5 @@ --- -title: "Code" +title: "Format code" description: "Display inline code and code blocks" --- diff --git a/components/files.mdx b/create/files.mdx similarity index 100% rename from components/files.mdx rename to create/files.mdx diff --git a/image-embeds.mdx b/create/image-embeds.mdx similarity index 100% rename from image-embeds.mdx rename to create/image-embeds.mdx diff --git a/list-table.mdx b/create/list-table.mdx similarity index 100% rename from list-table.mdx rename to create/list-table.mdx diff --git a/reusable-snippets.mdx b/create/reusable-snippets.mdx similarity index 100% rename from reusable-snippets.mdx rename to create/reusable-snippets.mdx diff --git a/text.mdx b/create/text.mdx similarity index 99% rename from text.mdx rename to create/text.mdx index de8b9e386..3bf9747c0 100644 --- a/text.mdx +++ b/create/text.mdx @@ -1,5 +1,5 @@ --- -title: "Headers and text" +title: "Format text" description: "Learn how to format text, create headers, and style content" --- diff --git a/docs.json b/docs.json index f8b3ab530..0b10bfd84 100644 --- a/docs.json +++ b/docs.json @@ -69,16 +69,17 @@ ] }, { - "group": "Write and edit", + "group": "Create content", "icon": "pen-line", "pages": [ - "text", - "code", - "image-embeds", - "components/files", - "list-table", + "create/text", + "create/code", + "create/image-embeds", + "create/files", + "create/list-table", { "group": "Components", + "expanded": true, "pages": [ "components/accordions", "components/banner", @@ -100,40 +101,41 @@ "components/update" ] }, + "create/reusable-snippets", + "create/broken-links", + "create/changelogs" + ] + }, + { + "group": "Document APIs", + "icon": "file-json", + "pages": [ + "api-playground/overview", + "api-playground/openapi-setup", { - "group": "API playground", + "group": "Customization", "pages": [ - "api-playground/overview", - "api-playground/openapi-setup", - { - "group": "Customization", - "pages": [ - "api-playground/customization/complex-data-types", - "api-playground/customization/adding-sdk-examples", - "api-playground/customization/managing-page-visibility", - "api-playground/customization/multiple-responses" - ] - }, - { - "group": "MDX", - "pages": [ - "api-playground/mdx/configuration", - "api-playground/mdx/authentication" - ] - }, - { - "group": "AsyncAPI", - "pages": [ - "api-playground/asyncapi/setup", - "api-playground/asyncapi/playground" - ] - }, - "api-playground/troubleshooting" + "api-playground/customization/complex-data-types", + "api-playground/customization/adding-sdk-examples", + "api-playground/customization/managing-page-visibility", + "api-playground/customization/multiple-responses" + ] + }, + { + "group": "MDX", + "pages": [ + "api-playground/mdx/configuration", + "api-playground/mdx/authentication" + ] + }, + { + "group": "AsyncAPI", + "pages": [ + "api-playground/asyncapi/setup", + "api-playground/asyncapi/playground" ] }, - "reusable-snippets", - "settings/broken-links", - "guides/changelogs" + "api-playground/troubleshooting" ] }, { From 2e426260ebd2f2c59c93f87927a2947b8e95c07c Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 30 Sep 2025 17:02:58 -0700 Subject: [PATCH 34/43] shorten URLs --- {customize/dashboard => dashboard}/permissions.mdx | 0 {customize/dashboard => dashboard}/roles.mdx | 0 {customize/dashboard => dashboard}/sso.mdx | 0 docs.json | 6 +++--- 4 files changed, 3 insertions(+), 3 deletions(-) rename {customize/dashboard => dashboard}/permissions.mdx (100%) rename {customize/dashboard => dashboard}/roles.mdx (100%) rename {customize/dashboard => dashboard}/sso.mdx (100%) diff --git a/customize/dashboard/permissions.mdx b/dashboard/permissions.mdx similarity index 100% rename from customize/dashboard/permissions.mdx rename to dashboard/permissions.mdx diff --git a/customize/dashboard/roles.mdx b/dashboard/roles.mdx similarity index 100% rename from customize/dashboard/roles.mdx rename to dashboard/roles.mdx diff --git a/customize/dashboard/sso.mdx b/dashboard/sso.mdx similarity index 100% rename from customize/dashboard/sso.mdx rename to dashboard/sso.mdx diff --git a/docs.json b/docs.json index 0b10bfd84..6f4de4047 100644 --- a/docs.json +++ b/docs.json @@ -60,9 +60,9 @@ { "group": "Dashboard access", "pages": [ - "customize/dashboard/sso", - "customize/dashboard/permissions", - "customize/dashboard/roles" + "dashboard/sso", + "dashboard/permissions", + "dashboard/roles" ] }, "customize/custom-404-page" From 384f3db25e398c5e8df39c152f0315f3f6650ef7 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 30 Sep 2025 17:05:58 -0700 Subject: [PATCH 35/43] update API group --- .../{customization => }/adding-sdk-examples.mdx | 0 .../{customization => }/complex-data-types.mdx | 0 .../managing-page-visibility.mdx | 0 .../{customization => }/multiple-responses.mdx | 0 docs.json | 13 ++++--------- 5 files changed, 4 insertions(+), 9 deletions(-) rename api-playground/{customization => }/adding-sdk-examples.mdx (100%) rename api-playground/{customization => }/complex-data-types.mdx (100%) rename api-playground/{customization => }/managing-page-visibility.mdx (100%) rename api-playground/{customization => }/multiple-responses.mdx (100%) diff --git a/api-playground/customization/adding-sdk-examples.mdx b/api-playground/adding-sdk-examples.mdx similarity index 100% rename from api-playground/customization/adding-sdk-examples.mdx rename to api-playground/adding-sdk-examples.mdx diff --git a/api-playground/customization/complex-data-types.mdx b/api-playground/complex-data-types.mdx similarity index 100% rename from api-playground/customization/complex-data-types.mdx rename to api-playground/complex-data-types.mdx diff --git a/api-playground/customization/managing-page-visibility.mdx b/api-playground/managing-page-visibility.mdx similarity index 100% rename from api-playground/customization/managing-page-visibility.mdx rename to api-playground/managing-page-visibility.mdx diff --git a/api-playground/customization/multiple-responses.mdx b/api-playground/multiple-responses.mdx similarity index 100% rename from api-playground/customization/multiple-responses.mdx rename to api-playground/multiple-responses.mdx diff --git a/docs.json b/docs.json index 6f4de4047..5c2afc4fb 100644 --- a/docs.json +++ b/docs.json @@ -112,15 +112,10 @@ "pages": [ "api-playground/overview", "api-playground/openapi-setup", - { - "group": "Customization", - "pages": [ - "api-playground/customization/complex-data-types", - "api-playground/customization/adding-sdk-examples", - "api-playground/customization/managing-page-visibility", - "api-playground/customization/multiple-responses" - ] - }, + "api-playground/complex-data-types", + "api-playground/adding-sdk-examples", + "api-playground/managing-page-visibility", + "api-playground/multiple-responses", { "group": "MDX", "pages": [ From f0aafd0fa75e324042dccec37876a2d7a4c3f6c9 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 30 Sep 2025 17:10:34 -0700 Subject: [PATCH 36/43] update deploy group --- .../authentication-setup.mdx | 0 {settings => deploy}/ci.mdx | 0 {advanced/subpath => deploy}/cloudflare.mdx | 0 {guides => deploy}/csp-configuration.mdx | 0 {guides => deploy}/deployments.mdx | 0 {settings => deploy}/github.mdx | 0 {settings => deploy}/gitlab.mdx | 0 {guides => deploy}/monorepo.mdx | 0 .../personalization-setup.mdx | 0 {settings => deploy}/preview-deployments.mdx | 0 {guides => deploy}/reverse-proxy.mdx | 0 .../subpath => deploy}/route53-cloudfront.mdx | 0 {advanced/subpath => deploy}/vercel.mdx | 0 docs.json | 27 ++++++++++--------- 14 files changed, 14 insertions(+), 13 deletions(-) rename {authentication-personalization => deploy}/authentication-setup.mdx (100%) rename {settings => deploy}/ci.mdx (100%) rename {advanced/subpath => deploy}/cloudflare.mdx (100%) rename {guides => deploy}/csp-configuration.mdx (100%) rename {guides => deploy}/deployments.mdx (100%) rename {settings => deploy}/github.mdx (100%) rename {settings => deploy}/gitlab.mdx (100%) rename {guides => deploy}/monorepo.mdx (100%) rename {authentication-personalization => deploy}/personalization-setup.mdx (100%) rename {settings => deploy}/preview-deployments.mdx (100%) rename {guides => deploy}/reverse-proxy.mdx (100%) rename {advanced/subpath => deploy}/route53-cloudfront.mdx (100%) rename {advanced/subpath => deploy}/vercel.mdx (100%) diff --git a/authentication-personalization/authentication-setup.mdx b/deploy/authentication-setup.mdx similarity index 100% rename from authentication-personalization/authentication-setup.mdx rename to deploy/authentication-setup.mdx diff --git a/settings/ci.mdx b/deploy/ci.mdx similarity index 100% rename from settings/ci.mdx rename to deploy/ci.mdx diff --git a/advanced/subpath/cloudflare.mdx b/deploy/cloudflare.mdx similarity index 100% rename from advanced/subpath/cloudflare.mdx rename to deploy/cloudflare.mdx diff --git a/guides/csp-configuration.mdx b/deploy/csp-configuration.mdx similarity index 100% rename from guides/csp-configuration.mdx rename to deploy/csp-configuration.mdx diff --git a/guides/deployments.mdx b/deploy/deployments.mdx similarity index 100% rename from guides/deployments.mdx rename to deploy/deployments.mdx diff --git a/settings/github.mdx b/deploy/github.mdx similarity index 100% rename from settings/github.mdx rename to deploy/github.mdx diff --git a/settings/gitlab.mdx b/deploy/gitlab.mdx similarity index 100% rename from settings/gitlab.mdx rename to deploy/gitlab.mdx diff --git a/guides/monorepo.mdx b/deploy/monorepo.mdx similarity index 100% rename from guides/monorepo.mdx rename to deploy/monorepo.mdx diff --git a/authentication-personalization/personalization-setup.mdx b/deploy/personalization-setup.mdx similarity index 100% rename from authentication-personalization/personalization-setup.mdx rename to deploy/personalization-setup.mdx diff --git a/settings/preview-deployments.mdx b/deploy/preview-deployments.mdx similarity index 100% rename from settings/preview-deployments.mdx rename to deploy/preview-deployments.mdx diff --git a/guides/reverse-proxy.mdx b/deploy/reverse-proxy.mdx similarity index 100% rename from guides/reverse-proxy.mdx rename to deploy/reverse-proxy.mdx diff --git a/advanced/subpath/route53-cloudfront.mdx b/deploy/route53-cloudfront.mdx similarity index 100% rename from advanced/subpath/route53-cloudfront.mdx rename to deploy/route53-cloudfront.mdx diff --git a/advanced/subpath/vercel.mdx b/deploy/vercel.mdx similarity index 100% rename from advanced/subpath/vercel.mdx rename to deploy/vercel.mdx diff --git a/docs.json b/docs.json index 5c2afc4fb..a93a1e2ad 100644 --- a/docs.json +++ b/docs.json @@ -137,24 +137,25 @@ "group": "Deploy", "icon": "boxes", "pages": [ - "guides/deployments", - "settings/preview-deployments", + "deploy/deployments", + "deploy/preview-deployments", { "group": "Custom subdirectory", + "expanded": true, "pages": [ - "advanced/subpath/cloudflare", - "advanced/subpath/route53-cloudfront", - "advanced/subpath/vercel", - "guides/reverse-proxy", - "guides/csp-configuration" + "deploy/cloudflare", + "deploy/route53-cloudfront", + "deploy/vercel", + "deploy/reverse-proxy", + "deploy/csp-configuration" ] }, - "authentication-personalization/authentication-setup", - "authentication-personalization/personalization-setup", - "guides/monorepo", - "settings/ci", - "settings/github", - "settings/gitlab" + "deploy/authentication-setup", + "deploy/personalization-setup", + "deploy/monorepo", + "deploy/ci", + "deploy/github", + "deploy/gitlab" ] }, { From daa31c7c015d9bc08d36e2826beaaa987f743f62 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 30 Sep 2025 17:15:07 -0700 Subject: [PATCH 37/43] update optimize and guides groups --- {guides => ai}/assistant.mdx | 0 docs.json | 20 +++++++++---------- {editor => guides}/branches.mdx | 0 {editor => guides}/git-concepts.mdx | 0 {analytics => guides}/improving-docs.mdx | 0 .../migrating-from-mdx.mdx | 0 {settings => optimize}/seo.mdx | 0 7 files changed, 10 insertions(+), 10 deletions(-) rename {guides => ai}/assistant.mdx (100%) rename {editor => guides}/branches.mdx (100%) rename {editor => guides}/git-concepts.mdx (100%) rename {analytics => guides}/improving-docs.mdx (100%) rename {api-playground => guides}/migrating-from-mdx.mdx (100%) rename {settings => optimize}/seo.mdx (100%) diff --git a/guides/assistant.mdx b/ai/assistant.mdx similarity index 100% rename from guides/assistant.mdx rename to ai/assistant.mdx diff --git a/docs.json b/docs.json index a93a1e2ad..e58636779 100644 --- a/docs.json +++ b/docs.json @@ -164,8 +164,9 @@ "pages": [ { "group": "AI", + "expanded": true, "pages": [ - "guides/assistant", + "ai/assistant", "ai/agent", "ai/llmstxt", "ai/contextual-menu", @@ -182,7 +183,7 @@ "analytics/search" ] }, - "settings/seo", + "optimize/seo", { "group": "Integrations", "pages": [ @@ -230,8 +231,7 @@ ] } ] - }, - "contact-support" + } ] } ] @@ -253,22 +253,22 @@ "group": "API docs", "icon": "file-json", "pages": [ - "api-playground/migrating-from-mdx" + "guides/migrating-from-mdx" ] }, { "group": "Analytics", "icon": "chart-line", "pages": [ - "analytics/improving-docs" + "guides/improving-docs" ] }, { "group": "Git", "icon": "git-merge", "pages": [ - "editor/git-concepts", - "editor/branches" + "guides/git-concepts", + "guides/branches" ] } ] @@ -1199,8 +1199,8 @@ "href": "https://www.mintlify.com/pricing" }, { - "label": "Guides", - "href": "https://www.mintlify.com/guides" + "label": "Contact support", + "href": "https://www.mintlify.com/docs/contact-support" }, { "label": "Feature Requests", diff --git a/editor/branches.mdx b/guides/branches.mdx similarity index 100% rename from editor/branches.mdx rename to guides/branches.mdx diff --git a/editor/git-concepts.mdx b/guides/git-concepts.mdx similarity index 100% rename from editor/git-concepts.mdx rename to guides/git-concepts.mdx diff --git a/analytics/improving-docs.mdx b/guides/improving-docs.mdx similarity index 100% rename from analytics/improving-docs.mdx rename to guides/improving-docs.mdx diff --git a/api-playground/migrating-from-mdx.mdx b/guides/migrating-from-mdx.mdx similarity index 100% rename from api-playground/migrating-from-mdx.mdx rename to guides/migrating-from-mdx.mdx diff --git a/settings/seo.mdx b/optimize/seo.mdx similarity index 100% rename from settings/seo.mdx rename to optimize/seo.mdx From 4c568e4e701f2fdd2209fb63488bfd4c28b8c6f6 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 30 Sep 2025 17:26:51 -0700 Subject: [PATCH 38/43] set up redirects --- docs.json | 202 +++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 185 insertions(+), 17 deletions(-) diff --git a/docs.json b/docs.json index e58636779..8bf19e97f 100644 --- a/docs.json +++ b/docs.json @@ -1307,10 +1307,6 @@ "source": "/content/components/update", "destination": "/components/update" }, - { - "source": "/api-playground/openapi/advanced-features", - "destination": "/api-playground/customization" - }, { "source": "/api-playground/openapi/setup", "destination": "/api-playground/openapi-setup" @@ -1333,55 +1329,55 @@ }, { "source": "settings/authentication-personalization/authentication", - "destination": "authentication-personalization/authentication-setup" + "destination": "deploy/authentication-setup" }, { "source": "settings/authentication-personalization/personalization", - "destination": "authentication-personalization/personalization-setup" + "destination": "deploy/personalization-setup" }, { "source": "settings/authentication-personalization/partial-authentication", - "destination": "authentication-personalization/authentication-setup" + "destination": "deploy/authentication-setup" }, { "source": "settings/authentication-personalization/sending-data", - "destination": "authentication-personalization/personalization-setup" + "destination": "deploy/personalization-setup" }, { "source": "authentication-personalization/partial-authentication-setup", - "destination": "authentication-personalization/authentication-setup" + "destination": "deploy/authentication-setup" }, { "source": "authentication-personalization/sending-data", - "destination": "authentication-personalization/personalization-setup" + "destination": "deploy/personalization-setup" }, { "source": "settings/authentication-personalization/authentication-setup/jwt", - "destination": "authentication-personalization/authentication-setup" + "destination": "deploy/authentication-setup" }, { "source": "settings/authentication-personalization/authentication-setup/oauth", - "destination": "authentication-personalization/authentication-setup" + "destination": "deploy/authentication-setup" }, { "source": "settings/authentication-personalization/authentication-setup/mintlify", - "destination": "authentication-personalization/authentication-setup" + "destination": "deploy/authentication-setup" }, { "source": "settings/authentication-personalization/authentication-setup/password", - "destination": "authentication-personalization/authentication-setup" + "destination": "deploy/authentication-setup" }, { "source": "settings/authentication-personalization/personalization-setup/jwt", - "destination": "authentication-personalization/personalization-setup" + "destination": "deploy/personalization-setup" }, { "source": "settings/authentication-personalization/personalization-setup/oauth", - "destination": "authentication-personalization/personalization-setup" + "destination": "deploy/personalization-setup" }, { "source": "settings/authentication-personalization/personalization-setup/shared-session", - "destination": "authentication-personalization/personalization-setup" + "destination": "deploy/personalization-setup" }, { "source": "ai-ingestion", @@ -1398,6 +1394,178 @@ { "source": "guides/analytics", "destination": "analytics/overview" + }, + { + "source": "guides/assistant", + "destination": "ai/assistant" + }, + { + "source": "api-playground/customization/adding-sdk-examples", + "destination": "api-playground/adding-sdk-examples" + }, + { + "source": "api-playground/customization/complex-data-types", + "destination": "api-playground/complex-data-types" + }, + { + "source": "api-playground/customization/managing-page-visibility", + "destination": "api-playground/managing-page-visibility" + }, + { + "source": "api-playground/customization/multiple-responses", + "destination": "api-playground/multiple-responses" + }, + { + "source": "settings/broken-links", + "destination": "create/broken-links" + }, + { + "source": "guides/changelogs", + "destination": "create/changelogs" + }, + { + "source": "code", + "destination": "create/code" + }, + { + "source": "components/files", + "destination": "create/files" + }, + { + "source": "image-embeds", + "destination": "create/image-embeds" + }, + { + "source": "list-table", + "destination": "create/list-table" + }, + { + "source": "reusable-snippets", + "destination": "create/reusable-snippets" + }, + { + "source": "text", + "destination": "create/text" + }, + { + "source": "settings/custom-404-page", + "destination": "customize/custom-404-page" + }, + { + "source": "settings/custom-domain", + "destination": "customize/custom-domain" + }, + { + "source": "settings/custom-scripts", + "destination": "customize/custom-scripts" + }, + { + "source": "react-components", + "destination": "customize/react-components" + }, + { + "source": "themes", + "destination": "customize/themes" + }, + { + "source": "advanced/dashboard/permissions", + "destination": "dashboard/permissions" + }, + { + "source": "advanced/dashboard/roles", + "destination": "dashboard/roles" + }, + { + "source": "advanced/dashboard/sso", + "destination": "dashboard/sso" + }, + { + "source": "settings/ci", + "destination": "deploy/ci" + }, + { + "source": "advanced/subpath/cloudflare", + "destination": "deploy/cloudflare" + }, + { + "source": "guides/csp-configuration", + "destination": "deploy/csp-configuration" + }, + { + "source": "guides/deployments", + "destination": "deploy/deployments" + }, + { + "source": "settings/github", + "destination": "deploy/github" + }, + { + "source": "settings/gitlab", + "destination": "deploy/gitlab" + }, + { + "source": "guides/monorepo", + "destination": "deploy/monorepo" + }, + { + "source": "settings/preview-deployments", + "destination": "deploy/preview-deployments" + }, + { + "source": "guides/reverse-proxy", + "destination": "deploy/reverse-proxy" + }, + { + "source": "advanced/subpath/route53-cloudfront", + "destination": "deploy/route53-cloudfront" + }, + { + "source": "advanced/subpath/vercel", + "destination": "deploy/vercel" + }, + { + "source": "editor/branches", + "destination": "guides/branches" + }, + { + "source": "editor/git-concepts", + "destination": "guides/git-concepts" + }, + { + "source": "analytics/improving-docs", + "destination": "guides/improving-docs" + }, + { + "source": "api-playground/migrating-from-mdx", + "destination": "guides/migrating-from-mdx" + }, + { + "source": "guides/migration", + "destination": "migration" + }, + { + "source": "settings/seo", + "destination": "optimize/seo" + }, + { + "source": "guides/hidden-page-example", + "destination": "organize/hidden-page-example" + }, + { + "source": "guides/hidden-pages", + "destination": "organize/hidden-pages" + }, + { + "source": "navigation", + "destination": "organize/navigation" + }, + { + "source": "pages", + "destination": "organize/pages" + }, + { + "source": "settings", + "destination": "organize/settings" } ], "integrations": { From 063587322c09155a47fe1e30885fc5dfd9d04e6b Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 30 Sep 2025 18:01:57 -0700 Subject: [PATCH 39/43] update links --- ai-native.mdx | 2 +- ai/assistant.mdx | 2 +- api-playground/mdx/configuration.mdx | 4 ++-- api-playground/openapi-setup.mdx | 2 +- api-playground/troubleshooting.mdx | 2 +- authentication-personalization/overview.mdx | 2 +- changelog.mdx | 8 ++++---- components/code-groups.mdx | 2 +- components/update.mdx | 2 +- create/changelogs.mdx | 2 +- create/code.mdx | 2 +- create/reusable-snippets.mdx | 2 +- customize/custom-domain.mdx | 2 +- customize/react-components.mdx | 2 +- deploy/authentication-setup.mdx | 4 ++-- deploy/ci.mdx | 4 ++-- deploy/deployments.mdx | 2 +- deploy/preview-deployments.mdx | 2 +- editor/getting-started.mdx | 4 ++-- editor/troubleshooting.mdx | 2 +- guides/git-concepts.mdx | 2 +- installation.mdx | 2 +- migration.mdx | 4 ++-- organize/hidden-page-example.mdx | 4 ++-- organize/hidden-pages.mdx | 2 +- organize/pages.mdx | 2 +- organize/settings.mdx | 2 +- 27 files changed, 36 insertions(+), 36 deletions(-) diff --git a/ai-native.mdx b/ai-native.mdx index 4f5bee8b4..27f85904c 100644 --- a/ai-native.mdx +++ b/ai-native.mdx @@ -32,7 +32,7 @@ Full-text search and semantic understanding help users and AI tools find relevan Select any of the following cards for more information. - + Configure the assistant to search external sites or direct people to your support team if it can't answer their questions. diff --git a/ai/assistant.mdx b/ai/assistant.mdx index 8a0931e26..e5ea70b54 100644 --- a/ai/assistant.mdx +++ b/ai/assistant.mdx @@ -113,7 +113,7 @@ Structure your documentation to help the assistant provide accurate, relevant an - Provide sufficient conceptual content about features and procedures. - Include examples and use cases. - Cross-reference related topics. - - Add [hidden pages](/guides/hidden-pages) with additional context that users don't need, but the assistant can reference. + - Add [hidden pages](/organize/hidden-pages) with additional context that users don't need, but the assistant can reference. ## Exporting and analyzing queries diff --git a/api-playground/mdx/configuration.mdx b/api-playground/mdx/configuration.mdx index c7eb6a46d..c42f774af 100644 --- a/api-playground/mdx/configuration.mdx +++ b/api-playground/mdx/configuration.mdx @@ -33,7 +33,7 @@ To generate pages for API endpoints using `MDX`, configure your API settings in } ``` - Find a full list of API configurations in [Settings](/settings#api-configurations). + Find a full list of API configurations in [Settings](/organize/settings#api-configurations). @@ -76,7 +76,7 @@ To generate pages for API endpoints using `MDX`, configure your API settings in - 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 in [Navigation](/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 in [Navigation](/organize/navigation). diff --git a/api-playground/openapi-setup.mdx b/api-playground/openapi-setup.mdx index 3c583b1c6..75693c08d 100644 --- a/api-playground/openapi-setup.mdx +++ b/api-playground/openapi-setup.mdx @@ -271,7 +271,7 @@ Generated endpoint pages have these default metadata values: To exclude specific endpoints from your auto-generated API pages, add the - [x-hidden](/api-playground/customization/managing-page-visibility#x-hidden) + [x-hidden](/api-playground/managing-page-visibility#x-hidden) property to the operation in your OpenAPI spec. diff --git a/api-playground/troubleshooting.mdx b/api-playground/troubleshooting.mdx index d354cf555..0b05a0ec2 100644 --- a/api-playground/troubleshooting.mdx +++ b/api-playground/troubleshooting.mdx @@ -68,7 +68,7 @@ If your API pages aren't displaying correctly, check these common configuration requests, then all of these requests will fail. To fix this, configure your reverse proxy to allow `POST` requests to the `/_mintlify/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 in the [settings documentation](/settings#param-proxy). When using this configuration, you will need to configure CORS on your server since requests will come directly from users' browsers rather than through your proxy. + 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 in the [settings documentation](/organize/settings#param-proxy). When using this configuration, you will need to configure CORS on your server since requests will come directly from users' browsers rather than through your proxy. If you are using an OpenAPI navigation configuration, but the pages aren't generating, check these common issues: diff --git a/authentication-personalization/overview.mdx b/authentication-personalization/overview.mdx index 5ec8f7f6e..1c2e03eaf 100644 --- a/authentication-personalization/overview.mdx +++ b/authentication-personalization/overview.mdx @@ -59,4 +59,4 @@ Choose the method that best fits your existing infrastructure and security requi ## Content customization -All three approaches support content personalization features including dynamic MDX content, API key prefilling, and page visibility controls. For detailed implementation guidance, see [Personalization setup](/authentication-personalization/personalization-setup). +All three approaches support content personalization features including dynamic MDX content, API key prefilling, and page visibility controls. For detailed implementation guidance, see [Personalization setup](/deploy/personalization-setup). diff --git a/changelog.mdx b/changelog.mdx index 95908f490..e0b08715b 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -200,7 +200,7 @@ noindex: true - Support for custom classnames in `h{1-4}` tags for applying custom heading styles - Fixed `h{1-4}` tags rendering as `Heading` components with chips in custom page mode -- Added CSS selectors to [breadcrumbs](/navigation#breadcrumbs) for custom CSS targeting +- Added CSS selectors to [breadcrumbs](/organize/navigation#breadcrumbs) for custom CSS targeting - Fixed stretched open-graph images by analyzing dimensions to maintain proportions at 56px height - Corrected `VSCode` to `VS Code` in contextual menu when enabled - Fixed headings within custom components appearing in table of contents alongside semantic headings @@ -327,13 +327,13 @@ noindex: true - Copy shortcut for code examples generated by assistant - "Ask AI" shortcut on code blocks in documentation to generate explanations from the assistant - Learn more in the [assistant docs](/guides/assistant). + Learn more in the [assistant docs](/ai/assistant). ## Subscribable changelogs - Automatically generate an RSS feed from changelog pages - Integrate RSS-enabled updates with Slack, email, and other tools - Learn more in our new [Changelog guide](/guides/changelogs) + Learn more in our new [Changelog guide](/create/changelogs) @@ -515,7 +515,7 @@ noindex: true ## GitLab Integration Upgrade - We've improved our support for syncing with GitLab, such as enabling automated updates and preview deployments. Check out our [docs on GitLab](/settings/gitlab) to get started. + We've improved our support for syncing with GitLab, such as enabling automated updates and preview deployments. Check out our [docs on GitLab](/deploy/gitlab) to get started. ## Web Editor diff --git a/components/code-groups.mdx b/components/code-groups.mdx index 78a7a49e7..58bb8f904 100644 --- a/components/code-groups.mdx +++ b/components/code-groups.mdx @@ -25,7 +25,7 @@ class HelloWorld { -Code groups inherit global styling from your `docs.json` file. Customize your theme using `styling.codeblocks`. See [Settings](/settings#styling) for configuration options. +Code groups inherit global styling from your `docs.json` file. Customize your theme using `styling.codeblocks`. See [Settings](/organize/settings#styling) for configuration options. ## Creating code groups diff --git a/components/update.mdx b/components/update.mdx index d389e26d6..b5583e848 100644 --- a/components/update.mdx +++ b/components/update.mdx @@ -32,7 +32,7 @@ Use the `Update` component to display changelog entries, version updates, and re ``` -Use multiple `Update` components to create [changelogs](/guides/changelogs). +Use multiple `Update` components to create [changelogs](/create/changelogs). ## Props diff --git a/create/changelogs.mdx b/create/changelogs.mdx index 51abbc2b6..be632aa69 100644 --- a/create/changelogs.mdx +++ b/create/changelogs.mdx @@ -94,7 +94,7 @@ Add `tags` to your `Update` components to replace the table of contents with tag - The table of contents and changelog filters are hidden when using `custom`, `center`, or `wide` page modes. Learn more about [page modes](/pages#page-mode). + The table of contents and changelog filters are hidden when using `custom`, `center`, or `wide` page modes. Learn more about [page modes](/organize/pages#page-mode). ### Subscribable changelogs diff --git a/create/code.mdx b/create/code.mdx index 772e4c5b0..b054c95a2 100644 --- a/create/code.mdx +++ b/create/code.mdx @@ -62,7 +62,7 @@ Enable syntax highlighting by specifying the programming language after the open We use [Shiki](https://shiki.style/) for syntax highlighting and support all available languages. See the full list of [languages](https://shiki.style/languages) in Shiki's documentation. -Customize code block themes globally using `styling.codeblocks` in your `docs.json` file. Set simple themes like `system` or `dark`, or configure custom [Shiki themes](https://shiki.style/themes) for light and dark modes. See [Settings](/settings#styling) for configuration options. +Customize code block themes globally using `styling.codeblocks` in your `docs.json` file. Set simple themes like `system` or `dark`, or configure custom [Shiki themes](https://shiki.style/themes) for light and dark modes. See [Settings](/organize/settings#styling) for configuration options. diff --git a/create/reusable-snippets.mdx b/create/reusable-snippets.mdx index a32ccf80b..233bd064c 100644 --- a/create/reusable-snippets.mdx +++ b/create/reusable-snippets.mdx @@ -97,7 +97,7 @@ Hello, my name is {myName} and I like {myObject.fruit}. ### JSX snippets -1. Export a JSX component from your snippet file. (See [React components](/react-components) for more information): +1. Export a JSX component from your snippet file. (See [React components](/customize/react-components) for more information): ```js icon=square-js snippets/my-jsx-snippet.jsx export const MyJSXSnippet = () => { diff --git a/customize/custom-domain.mdx b/customize/custom-domain.mdx index bf9083bcd..a0e5c2f8f 100644 --- a/customize/custom-domain.mdx +++ b/customize/custom-domain.mdx @@ -6,7 +6,7 @@ description: "Host your documentation at your website's custom domain" To set up your documentation on a custom domain, you'll need to set your desired custom domain in your Mintlify settings and configure your DNS settings on your domain provider. - Looking to set up a custom subdirectory like `mintlify.com/docs`? See the [custom subdirectory](/advanced/subpath/cloudflare) docs. + Looking to set up a custom subdirectory like `mintlify.com/docs`? See the [custom subdirectory](/deploy/cloudflare) docs. ## Dashboard settings diff --git a/customize/react-components.mdx b/customize/react-components.mdx index 3f6850f3a..7ca021b51 100644 --- a/customize/react-components.mdx +++ b/customize/react-components.mdx @@ -91,7 +91,7 @@ The counter renders as an interactive React component. ## Importing components -You can import components from your `snippets` folder. Unlike regular React, you cannot import components from every `MDX` file. Reusable components must be referenced from files within the `snippets` folder. Learn more about [reusable snippets](/reusable-snippets). +You can import components from your `snippets` folder. Unlike regular React, you cannot import components from every `MDX` file. Reusable components must be referenced from files within the `snippets` folder. Learn more about [reusable snippets](/create/reusable-snippets). ### Example diff --git a/deploy/authentication-setup.mdx b/deploy/authentication-setup.mdx index 308968ebb..04fbae74c 100644 --- a/deploy/authentication-setup.mdx +++ b/deploy/authentication-setup.mdx @@ -115,7 +115,7 @@ Your documentation is hosted at `docs.foo.com` and your team uses the dashboard To enable personalization features, create an API endpoint that: * Accepts OAuth access tokens for authentication. - * Returns user data in the `User` format. See [User data format](/authentication-personalization/personalization-setup#user-data-format) for more information. + * Returns user data in the `User` format. See [User data format](/deploy/personalization-setup#user-data-format) for more information. Add this endpoint URL to the **Info API URL** field in your [authentication settings](https://dashboard.mintlify.com/settings/deployment/authentication). @@ -167,7 +167,7 @@ Your documentation is hosted at `foo.com/docs` and you have an existing OAuth se Modify your existing login flow to include these steps after user authentication: - * Create a JWT containing the authenticated user's info in the `User` format. See [User data format](/authentication-personalization/personalization-setup#user-data-format) for more information. + * Create a JWT containing the authenticated user's info in the `User` format. See [User data format](/deploy/personalization-setup#user-data-format) for more information. * Sign the JWT with your secret key, using the EdDSA algorithm. * Create a redirect URL back to the `/login/jwt-callback` path of your docs, including the JWT as the hash. diff --git a/deploy/ci.mdx b/deploy/ci.mdx index 57b184e67..e28a1e989 100644 --- a/deploy/ci.mdx +++ b/deploy/ci.mdx @@ -11,7 +11,7 @@ Use CI checks to lint your docs for errors and provide warnings before you deplo ## Installation -To begin, follow the steps on the [GitHub](/settings/github) page. +To begin, follow the steps on the [GitHub](/deploy/github) page. For GitHub Apps, you can choose to give permissions to only a single repository. We highly recommend you do so as we only need access to the repository where your docs are hosted. @@ -28,7 +28,7 @@ When enabling checks, you can choose to run them at a `Warning` or `Blocking` le ### Broken links -Similar to how the [CLI link checker](/settings/broken-links#broken-links) works on your local machine, we automatically check your docs for broken links. +Similar to how the [CLI link checker](/create/broken-links#broken-links) works on your local machine, we automatically check your docs for broken links. To see the results of this check, visit GitHub's check results page for a specific commit. diff --git a/deploy/deployments.mdx b/deploy/deployments.mdx index a6e8ae4f3..54720f072 100644 --- a/deploy/deployments.mdx +++ b/deploy/deployments.mdx @@ -5,7 +5,7 @@ description: "Troubleshoot your deployments" Your documentation site automatically deploys when you push changes to your connected repository. This requires the Mintlify GitHub app to be properly installed and connected. -If your latest changes are not appearing on your live site, first check that the GitHub app is installed on the account or organization that owns your docs repository. See [GitHub troubleshooting](/settings/github#troubleshooting) for more information. +If your latest changes are not appearing on your live site, first check that the GitHub app is installed on the account or organization that owns your docs repository. See [GitHub troubleshooting](/deploy/github#troubleshooting) for more information. If the GitHub app is connected, but changes are still not deploying, you can manually trigger a rebuild from your dashboard. diff --git a/deploy/preview-deployments.mdx b/deploy/preview-deployments.mdx index eedc96322..0f59e3309 100644 --- a/deploy/preview-deployments.mdx +++ b/deploy/preview-deployments.mdx @@ -50,4 +50,4 @@ Preview deployments can be publicly accessible or restricted to authenticated us **Public access**: Preview URLs are publicly viewable by default. Share a preview link with anyone who needs to review your changes. -**Restricted access**: Enable preview deployment authentication to limit preview access to authenticated Mintlify users only. See [Authentication Setup](/authentication-personalization/authentication-setup) for more information. +**Restricted access**: Enable preview deployment authentication to limit preview access to authenticated Mintlify users only. See [Authentication Setup](/deploy/authentication-setup) for more information. diff --git a/editor/getting-started.mdx b/editor/getting-started.mdx index 5984aacfa..73763ee79 100644 --- a/editor/getting-started.mdx +++ b/editor/getting-started.mdx @@ -101,7 +101,7 @@ Markdown mode provides direct access to the underlying `MDX` code of your docume ## Next steps -- Learn fundamental [Git concepts](/editor/git-concepts). -- Learn best practices for collaborating with [branches](/editor/branches). +- Learn fundamental [Git concepts](/guides/git-concepts). +- Learn best practices for collaborating with [branches](/guides/branches). - Explore [content management](/editor/content-management) with the web editor. - Understand [publishing options](/editor/publishing) for different scenarios. diff --git a/editor/troubleshooting.mdx b/editor/troubleshooting.mdx index 6047a0a33..1e0aecdd4 100644 --- a/editor/troubleshooting.mdx +++ b/editor/troubleshooting.mdx @@ -27,7 +27,7 @@ Find solutions to common issues you might encounter while using the web editor. **Solutions:** 1. Verify you have correct access to the repository. 2. Check if your Git integration is properly configured. - 3. Review the [Editor Permissions](/advanced/dashboard/permissions) documentation. + 3. Review the [Editor Permissions](/dashboard/permissions) documentation. **Possible causes:** diff --git a/guides/git-concepts.mdx b/guides/git-concepts.mdx index 8f3d989dc..64f903391 100644 --- a/guides/git-concepts.mdx +++ b/guides/git-concepts.mdx @@ -39,7 +39,7 @@ The web editor performs some Git operations behind the scenes. Understanding the ## How the web editor uses Git -The web editor connects to your Git repository through the [GitHub App](/settings/github) or [GitLab integration](/settings/gitlab) and automates common Git operations. +The web editor connects to your Git repository through the [GitHub App](/deploy/github) or [GitLab integration](/deploy/gitlab) and automates common Git operations. When you: diff --git a/installation.mdx b/installation.mdx index 0c2491407..2a583f1dd 100644 --- a/installation.mdx +++ b/installation.mdx @@ -132,7 +132,7 @@ You can migrate MDX endpoint pages to autogenerated pages from your OpenAPI spec mint migrate-mdx ``` -This command converts individual MDX endpoint pages to autogenerated pages defined in your `docs.json`, moves MDX content to the `x-mint` extension in your OpenAPI specification, and updates your navigation. See [Migrating from MDX](/api-playground/migrating-from-mdx) for detailed information. +This command converts individual MDX endpoint pages to autogenerated pages defined in your `docs.json`, moves MDX content to the `x-mint` extension in your OpenAPI specification, and updates your navigation. See [Migrating from MDX](/guides/migrating-from-mdx) for detailed information. ## Formatting diff --git a/migration.mdx b/migration.mdx index 6f43f58ca..13e6b5444 100644 --- a/migration.mdx +++ b/migration.mdx @@ -148,8 +148,8 @@ Migrate your documentation from any platform with full control over the process. To migrate your content to Mintlify, you will need: -- A valid `docs.json` for your site settings and navigation. See [Global settings](/settings) and [Navigation](/navigation) for more information. -- An `MDX` file for each page of your documentation. See [Pages](/pages) for more information. +- A valid `docs.json` for your site settings and navigation. See [Global settings](/organize/settings) and [Navigation](/organize/navigation) for more information. +- An `MDX` file for each page of your documentation. See [Pages](/organize/pages) for more information. - (Optional) An OpenAPI specification for your API endpoint pages. See [OpenAPI setup](/api-playground/openapi-setup) for more information. 1. If your content is already in `MDX` format, copy the pages to your Mintlify project. Otherwise, convert your content to `MDX` format. diff --git a/organize/hidden-page-example.mdx b/organize/hidden-page-example.mdx index 91406a532..3a26427ce 100644 --- a/organize/hidden-page-example.mdx +++ b/organize/hidden-page-example.mdx @@ -5,12 +5,12 @@ description: "Common use cases for hidden pages" This page is hidden! It is not included in the `docs.json` navigation so you can only access it by its URL. -See [Hidden pages](/guides/hidden-pages) for more information. +See [Hidden pages](/organize/hidden-pages) for more information. ## Common use cases for hidden pages - By default, hidden pages are publicly accessible, but not discoverable through the navigation. If you want to restrict access to a hidden page, you must configure [authentication](/authentication-personalization/authentication-setup). + By default, hidden pages are publicly accessible, but not discoverable through the navigation. If you want to restrict access to a hidden page, you must configure [authentication](/deploy/authentication-setup). - **Beta documentation**: Information that can be public, but should not be discoverable through the navigation. diff --git a/organize/hidden-pages.mdx b/organize/hidden-pages.mdx index 8a103be17..7d8c1ffa6 100644 --- a/organize/hidden-pages.mdx +++ b/organize/hidden-pages.mdx @@ -7,7 +7,7 @@ Hidden pages are removed from your site's navigation but remain publicly accessi Use hidden pages for content that you want to be accessible on your site or referenced as context for AI tools, but not discoverable through the navigation. -For content requiring strict access control, you must configure [authentication](/authentication-personalization/authentication-setup). +For content requiring strict access control, you must configure [authentication](/deploy/authentication-setup). If you want to hide pages for specific groups of users, use personalization to control [page visibility](/authentication-personalization/overview#page-visibility). diff --git a/organize/pages.mdx b/organize/pages.mdx index b6c022201..51b33e12d 100644 --- a/organize/pages.mdx +++ b/organize/pages.mdx @@ -152,7 +152,7 @@ Most SEO meta tags are automatically generated. You can set SEO meta tags manual --- ``` -See [SEO](/settings/seo) for complete SEO metadata options. +See [SEO](/optimize/seo) for complete SEO metadata options. ## Internal search keywords diff --git a/organize/settings.mdx b/organize/settings.mdx index 549104b98..87fc5435d 100644 --- a/organize/settings.mdx +++ b/organize/settings.mdx @@ -703,7 +703,7 @@ See [Themes](themes) for more information. - Meta tags added to every page. Must be a valid key-value pair. See [common meta tags reference](/settings/seo#common-meta-tags-reference) for options. + Meta tags added to every page. Must be a valid key-value pair. See [common meta tags reference](/optimize/seo#common-meta-tags-reference) for options. Specify which pages search engines should index. Choose `navigable` to index only pages that are in your `docs.json` navigation or choose `all` to index every page. Defaults to `navigable`. From 865beaa9baba2943d3cfccd268d38d9675ee5d4b Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 1 Oct 2025 11:20:38 -0700 Subject: [PATCH 40/43] add pdf page --- pdf-exports.mdx => optimize/pdf-exports.mdx | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename pdf-exports.mdx => optimize/pdf-exports.mdx (100%) diff --git a/pdf-exports.mdx b/optimize/pdf-exports.mdx similarity index 100% rename from pdf-exports.mdx rename to optimize/pdf-exports.mdx From f7a4ea6c8e1833735cb0ade51facdb8e762edc9d Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 1 Oct 2025 11:39:22 -0700 Subject: [PATCH 41/43] add missing icons --- docs.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs.json b/docs.json index 561de76f8..0155428ba 100644 --- a/docs.json +++ b/docs.json @@ -279,10 +279,12 @@ "groups": [ { "group": "API Reference", + "icon": "file-json", "pages": ["api-reference/introduction"] }, { "group": "Admin", + "icon": "activity", "pages": [ "api-reference/update/trigger", "api-reference/update/status" @@ -290,6 +292,7 @@ }, { "group": "Agent", + "icon": "pen-line", "pages": [ "api-reference/agent/create-agent-job", "api-reference/agent/get-agent-job", @@ -298,6 +301,7 @@ }, { "group": "Assistant", + "icon": "bot-message-square", "pages": [ "api-reference/assistant/create-assistant-message", "api-reference/assistant/search" @@ -310,6 +314,7 @@ "groups": [ { "group": "Changelog", + "icon": "calendar", "pages": ["changelog"] } ] From b2f631b8d596b0e975ab3e2006e03945ad9d8fa1 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 1 Oct 2025 11:47:14 -0700 Subject: [PATCH 42/43] remove default expanded state --- docs.json | 3 --- optimize/pdf-exports.mdx | 1 - 2 files changed, 4 deletions(-) diff --git a/docs.json b/docs.json index 0155428ba..27ac28634 100644 --- a/docs.json +++ b/docs.json @@ -79,7 +79,6 @@ "create/list-table", { "group": "Components", - "expanded": true, "pages": [ "components/accordions", "components/banner", @@ -141,7 +140,6 @@ "deploy/preview-deployments", { "group": "Custom subdirectory", - "expanded": true, "pages": [ "deploy/cloudflare", "deploy/route53-cloudfront", @@ -164,7 +162,6 @@ "pages": [ { "group": "AI", - "expanded": true, "pages": [ "ai/assistant", "ai/agent", diff --git a/optimize/pdf-exports.mdx b/optimize/pdf-exports.mdx index b0ad251b5..6433d416b 100644 --- a/optimize/pdf-exports.mdx +++ b/optimize/pdf-exports.mdx @@ -1,6 +1,5 @@ --- title: "PDF exports" -icon: "file-down" description: "Export your docs as a single PDF file" --- From 0ec3e820ae9ad64845860b60ac4995472aabf27c Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Wed, 1 Oct 2025 11:54:12 -0700 Subject: [PATCH 43/43] update docs.json --- docs.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs.json b/docs.json index 27ac28634..e490e772b 100644 --- a/docs.json +++ b/docs.json @@ -168,8 +168,7 @@ "ai/llmstxt", "ai/contextual-menu", "ai/model-context-protocol", - "ai/markdown-export", - "ai/slack-app" + "ai/markdown-export" ] }, {