Skip to content

Commit e5e2b1c

Browse files
committed
Merge branch 'main' into kathryn/changelogs-guide
2 parents ddfa30f + 46d45b8 commit e5e2b1c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+1522
-442
lines changed

advanced/dashboard/permissions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Editor Permissions'
2+
title: 'Editor permissions'
33
description: 'Allow more members of your team to update your docs'
44
---
55

advanced/dashboard/sso.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
---
2-
title: "Single Sign-On (SSO)"
2+
title: "Single sign-on (SSO)"
33
description: "Customize how your team can login to your admin dashboard"
44
---
55

66
<Info>
7-
SSO functionality is available on our [Enterprise
8-
plan](https://mintlify.com/pricing?ref=sso). Please{" "}
9-
<a href="mailto:[email protected]">contact sales</a> for more information.
7+
SSO functionality is available on [Enterprise plan](https://mintlify.com/pricing?ref=sso).
108
</Info>
119

12-
Use single sign-on to your dashboard via SAML and OIDC. If you use Okta, Google Workspace, or Microsoft Entra, we have provider-specific documentation for setting up SSO. If you use another provider, please [contact us](mailto:sales@mintlify.com).
10+
Use single sign-on to your dashboard via SAML and OIDC. If you use Okta, Google Workspace, or Microsoft Entra, we have provider-specific documentation for setting up SSO. If you use another provider, please [contact us](mailto:support@mintlify.com).
1311

1412
## Okta
1513

advanced/subpath/route53-cloudfront.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ If you use Vercel, you use the `.vercel.app` domain available for every project.
4949
<Note>
5050

5151
If you're unsure on how to get a staging URL for your landing page, [contact
52-
support](https://mintlify.com/docs/support) and we'd be happy to help
52+
support](/contact-support) and we'd be happy to help
5353

5454
</Note>
5555

ai-ingestion.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "AI Ingestion"
2+
title: "AI ingestion"
33
description: "Prepare your documentation for LLMs and AI tools"
44
icon: "bot-message-square"
55
---

api-playground/asyncapi/setup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "AsyncAPI Setup"
2+
title: "AsyncAPI setup"
33
description: "Create websocket reference pages with AsyncAPI"
44
---
55

api-playground/mdx/configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'MDX Setup'
2+
title: 'MDX setup'
33
description: 'Generate docs pages for your API endpoints using `MDX`'
44
---
55

api-playground/openapi-setup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "OpenAPI Setup"
2+
title: "OpenAPI setup"
33
description: "Reference OpenAPI endpoints in your docs pages"
44
icon: "file-json"
55
---

authentication-personalization/authentication-setup.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: "Authentication Setup"
2+
title: "Authentication setup"
33
description: "Guarantee privacy of your docs by authenticating users"
44
icon: "file-lock"
5+
keywords: ['auth']
56
---
67
Authentication requires users to log in before accessing your documentation. This guide covers setup for each available handshake method.
78

89
**Need help choosing?** See the [overview](/authentication-personalization/overview) to compare options.
910

1011
<Info>
11-
Authentication methods are available on the [Growth and Enterprise plans](https://mintlify.com/pricing?ref=authentication). Please{" "}
12-
<a href="mailto:[email protected]">contact sales</a> for more information.
12+
Authentication methods are available on [Growth and Enterprise plans](https://mintlify.com/pricing?ref=authentication).
1313
</Info>
1414

1515
## Configuring authentication

authentication-personalization/overview.mdx

Lines changed: 49 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@
22
title: "Overview"
33
description: "Control who sees your documentation and customize their experience"
44
icon: "badge-info"
5+
keywords: ["auth"]
56
---
7+
68
<Info>
7-
Authentication methods are available on the [Growth and Enterprise plans](https://mintlify.com/pricing?ref=authentication). Please{" "}
8-
<a href="mailto:sales@mintlify.com">contact sales</a> for more information.
9+
Authentication methods are available on the [Growth and Enterprise
10+
plans](https://mintlify.com/pricing?ref=authentication).
911
</Info>
1012

1113
There are three approaches to manage access and customize your documentation based on user information.
1214

13-
* **Authentication**: Complete privacy protection for all content with full content customization.
14-
* **Partial authentication**: Page-by-page access control with full content customization.
15-
* **Personalization**: Content customization with **no security guarantees**. All content remains publicly accessible.
15+
- **Authentication**: Complete privacy protection for all content with full content customization.
16+
- **Partial authentication**: Page-by-page access control with full content customization.
17+
- **Personalization**: Content customization with **no security guarantees**. All content remains publicly accessible.
1618

1719
**Choose authentication** if you need complete security and privacy for all your documentation, including pages, images, search results, and AI assistant features.
1820

@@ -27,50 +29,55 @@ Authentication and personalization offer multiple handshake methods for controll
2729
### Available for all methods
2830

2931
**JSON Web Token (JWT)**: Custom system where you manage user tokens with full control over the login flow.
30-
* Pros of JWT:
31-
* Reduced risk of API endpoint abuse.
32-
* No CORS configuration.
33-
* No restrictions on API URLs.
34-
* Cons of JWT:
35-
* Must be compatible with your existing login flow.
36-
* Dashboard sessions and docs authentication are decoupled, so your team will log into your dashboard and your docs separately.
37-
* When you refresh user data, users must log into your docs again. If your users' data changes frequently, they must log in frequently or risk having stale data in your docs.
32+
33+
- Pros of JWT:
34+
- Reduced risk of API endpoint abuse.
35+
- No CORS configuration.
36+
- No restrictions on API URLs.
37+
- Cons of JWT:
38+
- Must be compatible with your existing login flow.
39+
- Dashboard sessions and docs authentication are decoupled, so your team will log into your dashboard and your docs separately.
40+
- When you refresh user data, users must log into your docs again. If your users' data changes frequently, they must log in frequently or risk having stale data in your docs.
3841

3942
**OAuth 2.0**: Third-party login integration like Google, GitHub, or other OAuth providers.
40-
* Pros of OAuth 2.0:
41-
* Heightened security standard.
42-
* No restrictions on API URLs.
43-
* Cons of OAuth 2.0:
44-
* Requires significant work if setting up an OAuth server for the first time.
45-
* Dashboard sessions and docs authentication are decoupled, so your team will log into your dashboard and your docs separately.
4643

47-
### Available for authentication and partial authentication
44+
- Pros of OAuth 2.0:
45+
- Heightened security standard.
46+
- No restrictions on API URLs.
47+
- Cons of OAuth 2.0:
48+
- Requires significant work if setting up an OAuth server for the first time.
49+
- Dashboard sessions and docs authentication are decoupled, so your team will log into your dashboard and your docs separately.
50+
51+
### Available for authentication and partial authentication
4852

4953
**Mintlify dashboard**: Allow all of your dashboard users to access your docs.
50-
* Pros of Mintlify dashboard:
51-
* No configuration required.
52-
* Enables private preview deployments, restricting access to authenticated users only.
53-
* Cons of Mintlify dashboard:
54-
* Requires all users of your docs to have an account in your Mintlify dashboard.
54+
55+
- Pros of Mintlify dashboard:
56+
- No configuration required.
57+
- Enables private preview deployments, restricting access to authenticated users only.
58+
- Cons of Mintlify dashboard:
59+
- Requires all users of your docs to have an account in your Mintlify dashboard.
5560

5661
**Password**: Shared access with a single global password. Used for access control only. Does not allow for personalization.
57-
* Pros of password:
58-
* Simple setup with no configuration required to add new users, just share the password.
59-
* Cons of password:
60-
* Lose personalization features since there is no way to differentiate users with the same password.
61-
* Must change the password to revoke access.
62+
63+
- Pros of password:
64+
- Simple setup with no configuration required to add new users, just share the password.
65+
- Cons of password:
66+
- Lose personalization features since there is no way to differentiate users with the same password.
67+
- Must change the password to revoke access.
6268

6369
### Available for personalization
6470

6571
**Shared session**: Use the same session token as your dashboard to personalize content.
66-
* Pros of shared session:
67-
* Users that are logged into your dashboard are automatically logged into your docs.
68-
* User sessions are persistent so you can refresh data without requiring a new login.
69-
* Minimal setup.
70-
* Cons of shared session:
71-
* Your docs will make a request to your backend.
72-
* You must have a dashboard that uses session authentication.
73-
* CORS configuration is generally required.
72+
73+
- Pros of shared session:
74+
- Users that are logged into your dashboard are automatically logged into your docs.
75+
- User sessions are persistent so you can refresh data without requiring a new login.
76+
- Minimal setup.
77+
- Cons of shared session:
78+
- Your docs will make a request to your backend.
79+
- You must have a dashboard that uses session authentication.
80+
- CORS configuration is generally required.
7481

7582
## Content customization
7683

@@ -109,10 +116,10 @@ Authentication is an enterprise feature. {
109116
```
110117
111118
<Note>
112-
The information in `user` is only available for logged in users. For
113-
logged out users, the value of `user` will be `{}`. To prevent the page from
114-
crashing for logged out users, always use optional chaining on your `user`
115-
fields. For example, `{user.org?.plan}`.
119+
The information in `user` is only available for logged in users. For logged
120+
out users, the value of `user` will be `{}`. To prevent the page from crashing
121+
for logged out users, always use optional chaining on your `user` fields. For
122+
example, `{user.org?.plan}`.
116123
</Note>
117124
118125
### API key prefilling

authentication-personalization/partial-authentication-setup.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
2-
title: "Partial Authentication Setup"
2+
title: "Partial authentication setup"
33
description: "Control access to specific pages"
44
icon: "file-lock-2"
5+
keywords: ["auth"]
56
---
67

78
Partial authentication lets you protect private documentation while keeping other pages publicly viewable. Users can browse public content freely and authenticate only when accessing protected pages.

0 commit comments

Comments
 (0)