Skip to content

Information architecture update #718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 20, 2025
Merged

Information architecture update #718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e8bfc55
Reorganize/relabel groups
ethanpalm May 19, 2025
368c727
Revise labels
ethanpalm May 19, 2025
2650500
add missing icons
ethanpalm May 20, 2025
ae9d37d
improve grouping/labelling
ethanpalm May 20, 2025
499a53e
Revert sentence casing
ethanpalm May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
188 changes: 96 additions & 92 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@
]
},
{
"group": "Core Concepts",
"group": "Core Configuration",
"pages": [
"settings",
"pages",
"navigation",
"themes",
"react-components",
"settings/custom-domain",
"ai-ingestion"
]
},
Expand Down Expand Up @@ -96,73 +96,47 @@
"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",
"icon": "file-cog",
"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",
"icon": "user-cog",
"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",
"settings/seo",
"settings/broken-links",
"settings/github",
"settings/gitlab",
"settings/ci",
"settings/preview-deployments",
"settings/custom-scripts",
"guides/migration",
"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"
]
}
]
},
"react-components",
"settings/custom-scripts",
"settings/seo",
"settings/broken-links",
{
"group": "Custom Subdirectory",
"icon": "folder",
Expand All @@ -172,36 +146,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",
Expand All @@ -213,6 +157,66 @@
]
}
]
},
{
"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/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"
]
}
]
},
Expand Down
5 changes: 3 additions & 2 deletions settings/authentication-personalization/authentication-vs-personalization.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions settings/authentication-personalization/authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Authentication"
description: "Guarantee privacy of your docs by authenticating users"
icon: "file-lock"
---

<Info>
Expand Down
1 change: 1 addition & 0 deletions settings/authentication-personalization/partial-authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -14,7 +15,7 @@

Partial Authentication shares all the same features as [Authentication](./authentication), but with the ability to allow unauthenticated users to view certain pages.

By default, all pages are protected. You can specify which pages should be publicly accessible by adding the `public` property to the page's frontmatter.

Check warning on line 18 in settings/authentication-personalization/partial-authentication.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/authentication-personalization/partial-authentication.mdx#L18 

Did you really mean 'frontmatter'?

```mdx
---
Expand Down
1 change: 1 addition & 0 deletions settings/authentication-personalization/personalization.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -9,7 +10,7 @@

- **Customize MDX content** with a user's information, such as their name, plan, or title.

- **Prefill API keys** in the API Playground for streamlined use.

Check warning on line 13 in settings/authentication-personalization/personalization.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/authentication-personalization/personalization.mdx#L13 

Did you really mean 'Prefill'?

- **Selectively show pages** in the navigation based on a user's groups.

Expand Down Expand Up @@ -52,9 +53,9 @@
fields, e.g. `{user.org?.plan}`
</Note>

### Prefilling API Keys

Check warning on line 56 in settings/authentication-personalization/personalization.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/authentication-personalization/personalization.mdx#L56 

Did you really mean 'Prefilling'?

If you return API Playground inputs in the user info, they will automatically be prefilled in the API Playground. Make sure the name of the field in the user info is an exact match of the name in the API Playground.

Check warning on line 58 in settings/authentication-personalization/personalization.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/authentication-personalization/personalization.mdx#L58 

Did you really mean 'prefilled'?

### Showing/Hiding Pages

Expand Down
5 changes: 3 additions & 2 deletions settings/authentication-personalization/sending-data.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -42,7 +43,7 @@
path="apiPlaygroundInputs"
type="object"
>
User-specific values that will be prefilled in the API playground if supplied. For example, if each of my customers makes requests at a specific subdomain, I can send `{ server: { subdomain: 'foo' } }` as my `apiPlaygroundInputs` field, and this value will be prefilled on any API page with this `subdomain` value.

Check warning on line 46 in settings/authentication-personalization/sending-data.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/authentication-personalization/sending-data.mdx#L46 

Did you really mean 'prefilled'?

Check warning on line 46 in settings/authentication-personalization/sending-data.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/authentication-personalization/sending-data.mdx#L46 

Did you really mean 'prefilled'?

<Note>The`header`, `query`, and `cookie` fields will only be prefilled if they are part of your [security scheme](https://swagger.io/docs/specification/authentication/). Creating a standard header parameter named `Authorization` is not sufficient to enable this feature. To know if a field will be prefilled, navigate to your existing docs and check if the field is in either the `Authorization` or `Server` section.</Note>
</ParamField>
Expand Down