Skip to content

Commit f93f0d5

Browse files
ethanpalmethanpalm
authored
Information architecture update (#718)
* Reorganize/relabel groups * Revise labels * add missing icons * improve grouping/labelling * Revert sentence casing
1 parent 85cf881 commit f93f0d5

File tree

6 files changed

+105
-96
lines changed

6 files changed

+105
-96
lines changed

‎docs.json‎

Lines changed: 96 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@
2828
]
2929
},
3030
{
31-
"group": "Core Concepts",
31+
"group": "Core Configuration",
3232
"pages": [
3333
"settings",
3434
"pages",
3535
"navigation",
3636
"themes",
37-
"react-components",
37+
"settings/custom-domain",
3838
"ai-ingestion"
3939
]
4040
},
@@ -96,73 +96,47 @@
9696
"api-playground/troubleshooting"
9797
]
9898
},
99-
{
100-
"group": "Guides",
99+
{
100+
"group": "Authentication and Personalization",
101101
"pages": [
102-
"guides/migration"
102+
"settings/authentication-personalization/authentication",
103+
"settings/authentication-personalization/partial-authentication",
104+
"settings/authentication-personalization/personalization",
105+
"settings/authentication-personalization/authentication-vs-personalization",
106+
{
107+
"group": "Authentication Setup",
108+
"icon": "file-cog",
109+
"pages": [
110+
"settings/authentication-personalization/authentication-setup/choosing-a-handshake",
111+
"settings/authentication-personalization/authentication-setup/password",
112+
"settings/authentication-personalization/authentication-setup/jwt",
113+
"settings/authentication-personalization/authentication-setup/oauth",
114+
"settings/authentication-personalization/authentication-setup/mintlify"
115+
]
116+
},
117+
{
118+
"group": "Personalization Setup",
119+
"icon": "user-cog",
120+
"pages": [
121+
"settings/authentication-personalization/personalization-setup/choosing-a-handshake",
122+
"settings/authentication-personalization/personalization-setup/shared-session",
123+
"settings/authentication-personalization/personalization-setup/jwt",
124+
"settings/authentication-personalization/personalization-setup/oauth"
125+
]
126+
},
127+
"settings/authentication-personalization/sending-data"
103128
]
104129
},
105130
{
106-
"group": "Deep Dive",
131+
"group": "Guides",
107132
"pages": [
108-
"settings/custom-domain",
109-
"settings/seo",
110-
"settings/broken-links",
111-
"settings/github",
112-
"settings/gitlab",
113-
"settings/ci",
114-
"settings/preview-deployments",
115-
"settings/custom-scripts",
133+
"guides/migration",
116134
"mcp",
117135
"translations",
118-
{
119-
"group": "Integrations",
120-
"icon": "blocks",
121-
"pages": [
122-
{
123-
"group": "Analytics",
124-
"pages": [
125-
"integrations/analytics/overview",
126-
"integrations/analytics/amplitude",
127-
"integrations/analytics/clearbit",
128-
"integrations/analytics/fathom",
129-
"integrations/analytics/google-analytics",
130-
"integrations/analytics/google-tag-manager",
131-
"integrations/analytics/heap",
132-
"integrations/analytics/hotjar",
133-
"integrations/analytics/koala",
134-
"integrations/analytics/logrocket",
135-
"integrations/analytics/mixpanel",
136-
"integrations/analytics/pirsch",
137-
"integrations/analytics/plausible",
138-
"integrations/analytics/posthog",
139-
"integrations/analytics/segment"
140-
]
141-
},
142-
{
143-
"group": "SDKs",
144-
"pages": [
145-
"integrations/sdks/speakeasy",
146-
"integrations/sdks/stainless"
147-
]
148-
},
149-
{
150-
"group": "Support",
151-
"pages": [
152-
"integrations/support/overview",
153-
"integrations/support/intercom",
154-
"integrations/support/front"
155-
]
156-
},
157-
{
158-
"group": "Privacy",
159-
"pages": [
160-
"integrations/privacy/overview",
161-
"integrations/privacy/osano"
162-
]
163-
}
164-
]
165-
},
136+
"react-components",
137+
"settings/custom-scripts",
138+
"settings/seo",
139+
"settings/broken-links",
166140
{
167141
"group": "Custom Subdirectory",
168142
"icon": "folder",
@@ -172,36 +146,6 @@
172146
"advanced/subpath/vercel"
173147
]
174148
},
175-
{
176-
"group": "Auth & Personalization",
177-
"icon": "user",
178-
"pages": [
179-
"settings/authentication-personalization/authentication",
180-
"settings/authentication-personalization/partial-authentication",
181-
"settings/authentication-personalization/personalization",
182-
"settings/authentication-personalization/authentication-vs-personalization",
183-
{
184-
"group": "Authentication Setup",
185-
"pages": [
186-
"settings/authentication-personalization/authentication-setup/choosing-a-handshake",
187-
"settings/authentication-personalization/authentication-setup/password",
188-
"settings/authentication-personalization/authentication-setup/jwt",
189-
"settings/authentication-personalization/authentication-setup/oauth",
190-
"settings/authentication-personalization/authentication-setup/mintlify"
191-
]
192-
},
193-
{
194-
"group": "Personalization Setup",
195-
"pages": [
196-
"settings/authentication-personalization/personalization-setup/choosing-a-handshake",
197-
"settings/authentication-personalization/personalization-setup/shared-session",
198-
"settings/authentication-personalization/personalization-setup/jwt",
199-
"settings/authentication-personalization/personalization-setup/oauth"
200-
]
201-
},
202-
"settings/authentication-personalization/sending-data"
203-
]
204-
},
205149
{
206150
"group": "Dashboard Access",
207151
"icon": "gauge",
@@ -213,6 +157,66 @@
213157
]
214158
}
215159
]
160+
},
161+
{
162+
"group": "Integrations",
163+
"pages": [
164+
{
165+
"group": "Analytics",
166+
"icon": "chart-no-axes-combined",
167+
"pages": [
168+
"integrations/analytics/overview",
169+
"integrations/analytics/amplitude",
170+
"integrations/analytics/clearbit",
171+
"integrations/analytics/fathom",
172+
"integrations/analytics/google-analytics",
173+
"integrations/analytics/google-tag-manager",
174+
"integrations/analytics/heap",
175+
"integrations/analytics/hotjar",
176+
"integrations/analytics/koala",
177+
"integrations/analytics/logrocket",
178+
"integrations/analytics/mixpanel",
179+
"integrations/analytics/pirsch",
180+
"integrations/analytics/plausible",
181+
"integrations/analytics/posthog",
182+
"integrations/analytics/segment"
183+
]
184+
},
185+
{
186+
"group": "SDKs",
187+
"icon": "folder-code",
188+
"pages": [
189+
"integrations/sdks/speakeasy",
190+
"integrations/sdks/stainless"
191+
]
192+
},
193+
{
194+
"group": "Support",
195+
"icon": "messages-square",
196+
"pages": [
197+
"integrations/support/overview",
198+
"integrations/support/intercom",
199+
"integrations/support/front"
200+
]
201+
},
202+
{
203+
"group": "Privacy",
204+
"icon": "folder-lock",
205+
"pages": [
206+
"integrations/privacy/overview",
207+
"integrations/privacy/osano"
208+
]
209+
}
210+
]
211+
},
212+
{
213+
"group": "Version Control and CI/CD",
214+
"pages": [
215+
"settings/github",
216+
"settings/gitlab",
217+
"settings/ci",
218+
"settings/preview-deployments"
219+
]
216220
}
217221
]
218222
},

‎settings/authentication-personalization/authentication-vs-personalization.mdx‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
title: 'Auth vs Personalization'
3-
description: 'How to determine which product is best for you'
2+
title: "Auth vs Personalization"
3+
description: "How to determine which product is best for you"
4+
icon: "arrow-right-left"
45
---
56

67
Mintlify offers both Authentication and Personalization. For the most part, Authentication is

‎settings/authentication-personalization/authentication.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Authentication"
33
description: "Guarantee privacy of your docs by authenticating users"
4+
icon: "file-lock"
45
---
56

67
<Info>

‎settings/authentication-personalization/partial-authentication.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Partial Authentication"
33
description: "Authenticate users to view only certain pages"
4+
icon: "file-lock-2"
45
---
56

67
Partial Authentication allows you to authenticate users to view only certain pages.

‎settings/authentication-personalization/personalization.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Personalization"
33
description: "A list of features unlocked with Personalization"
4+
icon: "user-pen"
45
---
56

67
Personalization refers to a suite of features that allow you to customize your

‎settings/authentication-personalization/sending-data.mdx‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
title: 'Sending Data'
3-
description: 'The shape of user data you can use to personalize your docs'
2+
title: "Sending Data"
3+
description: "The shape of user data you can use to personalize your docs"
4+
icon: "send"
45
---
56

67
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:

0 commit comments

Comments
 (0)