docs for User Auth #194
docs for User Auth #194
Conversation
hahnbeelee
left a comment
hahnbeelee
left a comment
There was a problem hiding this comment.
Ok so it looks like there are several different types of information we are surfacing to the user:
- educating them about the feature at a high level
- which option should they use?
- how to implement each option
- API reference/shape of the user auth object
- After wiring everything up properly - then actually customizing the data.
Things feel kinda jumbled up right now and there is a lot we are trying to accomplish.
I personally really like separating the pure technical content and more walking through/explaining the feature content - For the jwt and shared session pages, maybe we can create separate pages purely for setting up instructions and then just one page that guides you through which one you should be using (AKA all the pro's and con's and examples) which the overview page should then have links to all of these.
| 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. | ||
| 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. | ||
|
|
||
| ## How to Use |
There was a problem hiding this comment.
I feel like we should have a "How to Set Up" or at least like right below this "How to Use" explain that you need to choose between shared session or jwt and set it up in the dashboard?
|
I also think we could be doing more to really help the user understand what they can be accomplishing with this feature but I do think overall the overview page is really well written and i dont have tangible feedback on how to accomplish this. |
| </Step> | ||
| </Steps> | ||
|
|
||
| ## Examples |
There was a problem hiding this comment.
I think the examples should also go in the "choosing" page.
There was a problem hiding this comment.
I feel like it makes sense to have the examples here for when people actually need to implement stuff, no?
completes ENG-2847
https://mintlify-ronan-eng-2847-create-docs-for-user-auth.mintlify.app/integrations/user-auth/overview