From e8bfc55bd9de95c76ac653a4f31b9bce6f361b64 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 19 May 2025 16:39:11 -0700 Subject: [PATCH 1/5] Reorganize/relabel groups --- docs.json | 184 +++++++++++++++++++++++++++--------------------------- 1 file changed, 91 insertions(+), 93 deletions(-) diff --git a/docs.json b/docs.json index 48fd62d7e..2fd515c43 100644 --- a/docs.json +++ b/docs.json @@ -19,7 +19,7 @@ "description": "Set up your documentation", "groups": [ { - "group": "Getting Started", + "group": "Getting started", "pages": [ "index", "quickstart", @@ -28,14 +28,17 @@ ] }, { - "group": "Core Concepts", + "group": "Customizing your docs", "pages": [ "settings", "pages", "navigation", "themes", + "settings/custom-domain", "react-components", - "ai-ingestion" + "settings/custom-scripts", + "ai-ingestion", + "translations" ] }, { @@ -96,73 +99,42 @@ "api-playground/troubleshooting" ] }, - { - "group": "Guides", + { + "group": "Authentication and personalization", "pages": [ - "guides/migration" + "settings/authentication-personalization/authentication", + "settings/authentication-personalization/partial-authentication", + "settings/authentication-personalization/personalization", + "settings/authentication-personalization/authentication-vs-personalization", + { + "group": "Authentication Setup", + "pages": [ + "settings/authentication-personalization/authentication-setup/choosing-a-handshake", + "settings/authentication-personalization/authentication-setup/password", + "settings/authentication-personalization/authentication-setup/jwt", + "settings/authentication-personalization/authentication-setup/oauth", + "settings/authentication-personalization/authentication-setup/mintlify" + ] + }, + { + "group": "Personalization Setup", + "pages": [ + "settings/authentication-personalization/personalization-setup/choosing-a-handshake", + "settings/authentication-personalization/personalization-setup/shared-session", + "settings/authentication-personalization/personalization-setup/jwt", + "settings/authentication-personalization/personalization-setup/oauth" + ] + }, + "settings/authentication-personalization/sending-data" ] }, { - "group": "Deep Dive", + "group": "Guides", "pages": [ - "settings/custom-domain", + "guides/migration", + "mcp", "settings/seo", "settings/broken-links", - "settings/github", - "settings/gitlab", - "settings/ci", - "settings/preview-deployments", - "settings/custom-scripts", - "mcp", - "translations", - { - "group": "Integrations", - "icon": "blocks", - "pages": [ - { - "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/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": "Custom Subdirectory", "icon": "folder", @@ -172,36 +144,6 @@ "advanced/subpath/vercel" ] }, - { - "group": "Auth & Personalization", - "icon": "user", - "pages": [ - "settings/authentication-personalization/authentication", - "settings/authentication-personalization/partial-authentication", - "settings/authentication-personalization/personalization", - "settings/authentication-personalization/authentication-vs-personalization", - { - "group": "Authentication Setup", - "pages": [ - "settings/authentication-personalization/authentication-setup/choosing-a-handshake", - "settings/authentication-personalization/authentication-setup/password", - "settings/authentication-personalization/authentication-setup/jwt", - "settings/authentication-personalization/authentication-setup/oauth", - "settings/authentication-personalization/authentication-setup/mintlify" - ] - }, - { - "group": "Personalization Setup", - "pages": [ - "settings/authentication-personalization/personalization-setup/choosing-a-handshake", - "settings/authentication-personalization/personalization-setup/shared-session", - "settings/authentication-personalization/personalization-setup/jwt", - "settings/authentication-personalization/personalization-setup/oauth" - ] - }, - "settings/authentication-personalization/sending-data" - ] - }, { "group": "Dashboard Access", "icon": "gauge", @@ -213,6 +155,62 @@ ] } ] + }, + { + "group": "Integrations", + "pages": [ + { + "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/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": "Version control & CI/CD", + "pages": [ + "settings/github", + "settings/gitlab", + "settings/ci", + "settings/preview-deployments" + ] } ] }, From 368c7272d03decab26981e4fdd4450c8a2863f1b Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 19 May 2025 16:43:09 -0700 Subject: [PATCH 2/5] Revise labels --- docs.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs.json b/docs.json index 2fd515c43..446f23296 100644 --- a/docs.json +++ b/docs.json @@ -28,7 +28,7 @@ ] }, { - "group": "Customizing your docs", + "group": "Customization", "pages": [ "settings", "pages", @@ -68,7 +68,7 @@ ] }, { - "group": "API Pages", + "group": "API pages", "pages": [ "api-playground/overview", { From 2650500edc9b875b652296e66a0831fc7a681f14 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 19 May 2025 17:02:21 -0700 Subject: [PATCH 3/5] add missing icons --- docs.json | 6 ++++++ .../authentication-vs-personalization.mdx | 5 +++-- settings/authentication-personalization/authentication.mdx | 1 + .../partial-authentication.mdx | 1 + settings/authentication-personalization/personalization.mdx | 1 + settings/authentication-personalization/sending-data.mdx | 5 +++-- 6 files changed, 15 insertions(+), 4 deletions(-) diff --git a/docs.json b/docs.json index 446f23296..f8ffde500 100644 --- a/docs.json +++ b/docs.json @@ -108,6 +108,7 @@ "settings/authentication-personalization/authentication-vs-personalization", { "group": "Authentication Setup", + "icon": "file-cog", "pages": [ "settings/authentication-personalization/authentication-setup/choosing-a-handshake", "settings/authentication-personalization/authentication-setup/password", @@ -118,6 +119,7 @@ }, { "group": "Personalization Setup", + "icon": "user-cog", "pages": [ "settings/authentication-personalization/personalization-setup/choosing-a-handshake", "settings/authentication-personalization/personalization-setup/shared-session", @@ -161,6 +163,7 @@ "pages": [ { "group": "Analytics", + "icon": "chart-no-axes-combined", "pages": [ "integrations/analytics/overview", "integrations/analytics/amplitude", @@ -181,6 +184,7 @@ }, { "group": "SDKs", + "icon": "folder-code", "pages": [ "integrations/sdks/speakeasy", "integrations/sdks/stainless" @@ -188,6 +192,7 @@ }, { "group": "Support", + "icon": "messages-square", "pages": [ "integrations/support/overview", "integrations/support/intercom", @@ -196,6 +201,7 @@ }, { "group": "Privacy", + "icon": "folder-lock", "pages": [ "integrations/privacy/overview", "integrations/privacy/osano" diff --git a/settings/authentication-personalization/authentication-vs-personalization.mdx b/settings/authentication-personalization/authentication-vs-personalization.mdx index c6be06046..6b4dcf8a7 100644 --- a/settings/authentication-personalization/authentication-vs-personalization.mdx +++ b/settings/authentication-personalization/authentication-vs-personalization.mdx @@ -1,6 +1,7 @@ --- -title: 'Auth vs Personalization' -description: 'How to determine which product is best for you' +title: "Auth vs Personalization" +description: "How to determine which product is best for you" +icon: "arrow-right-left" --- Mintlify offers both Authentication and Personalization. For the most part, Authentication is diff --git a/settings/authentication-personalization/authentication.mdx b/settings/authentication-personalization/authentication.mdx index 2da3096be..94786d377 100644 --- a/settings/authentication-personalization/authentication.mdx +++ b/settings/authentication-personalization/authentication.mdx @@ -1,6 +1,7 @@ --- title: "Authentication" description: "Guarantee privacy of your docs by authenticating users" +icon: "file-lock" --- diff --git a/settings/authentication-personalization/partial-authentication.mdx b/settings/authentication-personalization/partial-authentication.mdx index 2d77eb0d1..b27f15ad5 100644 --- a/settings/authentication-personalization/partial-authentication.mdx +++ b/settings/authentication-personalization/partial-authentication.mdx @@ -1,6 +1,7 @@ --- title: "Partial Authentication" description: "Authenticate users to view only certain pages" +icon: "file-lock-2" --- Partial Authentication allows you to authenticate users to view only certain pages. diff --git a/settings/authentication-personalization/personalization.mdx b/settings/authentication-personalization/personalization.mdx index 05baef8e8..83baa4bb1 100644 --- a/settings/authentication-personalization/personalization.mdx +++ b/settings/authentication-personalization/personalization.mdx @@ -1,6 +1,7 @@ --- title: "Personalization" description: "A list of features unlocked with Personalization" +icon: "user-pen" --- Personalization refers to a suite of features that allow you to customize your diff --git a/settings/authentication-personalization/sending-data.mdx b/settings/authentication-personalization/sending-data.mdx index e969fa8bc..4fb4b4165 100644 --- a/settings/authentication-personalization/sending-data.mdx +++ b/settings/authentication-personalization/sending-data.mdx @@ -1,6 +1,7 @@ --- -title: 'Sending Data' -description: 'The shape of user data you can use to personalize your docs' +title: "Sending Data" +description: "The shape of user data you can use to personalize your docs" +icon: "send" --- Depending on your Handshake method, your API will respond with either a raw JSON object or a signed JWT. The shape of the data is the same for both: From ae9d37d03f67c96e267430979d4b5e1e8b478ebf Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 19 May 2025 17:10:35 -0700 Subject: [PATCH 4/5] improve grouping/labelling --- docs.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs.json b/docs.json index f8ffde500..62bf1efce 100644 --- a/docs.json +++ b/docs.json @@ -28,17 +28,14 @@ ] }, { - "group": "Customization", + "group": "Core configuration", "pages": [ "settings", "pages", "navigation", "themes", "settings/custom-domain", - "react-components", - "settings/custom-scripts", - "ai-ingestion", - "translations" + "ai-ingestion" ] }, { @@ -135,6 +132,9 @@ "pages": [ "guides/migration", "mcp", + "translations", + "react-components", + "settings/custom-scripts", "settings/seo", "settings/broken-links", { From 499a53ebf64cbe2556dca9bc40f45948ad78554f Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 19 May 2025 17:21:08 -0700 Subject: [PATCH 5/5] Revert sentence casing --- docs.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs.json b/docs.json index 62bf1efce..3b85c5ca2 100644 --- a/docs.json +++ b/docs.json @@ -19,7 +19,7 @@ "description": "Set up your documentation", "groups": [ { - "group": "Getting started", + "group": "Getting Started", "pages": [ "index", "quickstart", @@ -28,7 +28,7 @@ ] }, { - "group": "Core configuration", + "group": "Core Configuration", "pages": [ "settings", "pages", @@ -65,7 +65,7 @@ ] }, { - "group": "API pages", + "group": "API Pages", "pages": [ "api-playground/overview", { @@ -97,7 +97,7 @@ ] }, { - "group": "Authentication and personalization", + "group": "Authentication and Personalization", "pages": [ "settings/authentication-personalization/authentication", "settings/authentication-personalization/partial-authentication", @@ -210,7 +210,7 @@ ] }, { - "group": "Version control & CI/CD", + "group": "Version Control and CI/CD", "pages": [ "settings/github", "settings/gitlab",