Documentation overhaul#875
Merged
Merged
Conversation
lepture
approved these changes
Mar 28, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR changes the whole hierarchy of the documentation, but does not touches (much) the content.
The idea is to separate sections by spec (OAuth1 / OAuth2) and then by role (Client, Authorization server, Resource server). It feels more legible to me, because I guess most users will focus on one single OAuth version and one single usage matching one role (though AS and RS might sometimes go together).
We could have done it the other way : set roles at first level and spec at second level. This could sound more logical since clients can operate on both OAuth1 and OAuth2.
I suppose the right organization depends on where Authlib is heading to. If clients are to be extracted in a separate lib, like joserfc, then maybe the second option is the best?
@lepture, any thoughts?
Checklist