Skip to content

Commit 728b37b

Browse files
added images and tightened copy on User Auth page
1 parent abe76ea commit 728b37b

File tree

6 files changed

+12
-9
lines changed

6 files changed

+12
-9
lines changed

advanced/user-auth/overview.mdx

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,17 @@ title: 'Introduction'
33
description: 'Give your users a personalized docs experience'
44
---
55

6-
Sometimes, when writing docs, you wish you knew just a little bit about the person reading them. Maybe you only want to show them the information they should care about. Maybe you want to craft examples that they can use out-of-the-box.
6+
User Auth allows you to identify and authenticate your users so that you can personalize docs content for them. your users.
77

8-
With Mintlify, you can add User Auth to identify your users and tailor your docs content to them.
9-
10-
## What is User Auth
11-
12-
User Auth allows you to configure a method for identifying and authenticating your users. Once authenticated, you can share user-specific information that can be used to personalize the docs. This unlocks some powerful features:
8+
Example use cases:
139

1410
1. **Customize MDX content** with a user's information, such as their name, plan, or title.
1511
2. **Prefill API keys** in the API Playground for streamlined use.
1612
3. **Selectively show pages** in the navigation based on a user's groups.
1713

1814
## What *isn't* User Auth
1915

20-
At this time, User Auth cannot provide any of the following:
16+
At this time, User Auth is not meant for the following use cases:
2117

2218
1. **Private docs content.** While you can hide pages from unauthenticated users, those pages are still accessible by anyone who can guess the URL. If your documentation contains sensitive information, User Auth is not enough to hide it.
2319
2. **A Mintlify-backed user database.** Mintlify does not store *any* information about your users. Rather, it relies on your existing infrastructure to serve as the source-of-truth for user data.

changelog/overview.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,20 @@ mode: "wide"
66

77
<Update label="November 2024">
88
## Web Editor
9+
<Frame>
10+
<img src="/images/changelog/webeditor.jpg" alt="Web Editor" />
11+
</Frame>
912
We've revamped our web editor so that you can now update docs with a fully WYSIWYG experience, while syncing with markdown.
1013

1114
Check out our [docs on getting started with Web Editor](/webeditor).
1215

13-
## llms.txt
16+
## All docs now hosted at /llms.txt
17+
<Frame>
18+
<img src="/images/changelog/llms.jpg" alt="llms.txt support" />
19+
</Frame>
1420
All docs instances are now automatically hosted at /llms.txt and /llms-full.txt so that LLMs can easily ingest your documentation. For more information, read the [docs on the new llms.txt standard.](https://llmstxt.org)
1521

22+
1623
## Localization
1724
You can now localize your docs which operates similarly to versioning. Add a `locale` to a version and fixed content in Mintlify like "Was this page helpful?" will also match the locale.
1825

images/changelog/llms.jpg

667 KB
Loading

images/changelog/webeditor.jpg

4.01 MB
Loading

mint.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
"pages": [
6262
"quickstart",
6363
"development",
64-
"webeditor",
64+
"web-editor",
6565
"settings/global",
6666
"settings/navigation",
6767
"migration"
File renamed without changes.

0 commit comments

Comments
 (0)