Restructure and extend documentation #183
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Includes some minor tweaks to options to match documentation (non breaking changes).
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/iaincollins/next-auth-docs/8tbistzmc |
This was referenced Apr 15, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Includes some minor tweaks to options to match documentation (non breaking changes).
There is a lot in this PR, even though it's really just cleaning things up, adding missing documentation and splitting up docs to make it easier to read them.
I'm trying to make the docs more accessible as I'd done things that are not documented.
I'm not sure this is quite right still, but I think it's best to merge it in and continue to work on it. I hope I haven't introduced too many new typos and that things make sense.
I am leaning towards creating a page for every provider, even if it is very simple, so that folks can just copy and paste the code to add a provider, and as a place to write up notes about each specific provider (for those that have caveats).
Please feel free to amend structure if you think it can be improved. I'm not totally sure what direction to go in with the structure.
I'd much rather work on features - and maybe release 2.0 in the next day or so if I can finish of the work in progress - but I felt that spending some time on the docs seemed like the right thing to do as people have been asking about the same things a few times.