Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding an explanation section to the documentation #633

Open
consideRatio opened this issue Jul 3, 2023 · 0 comments
Open

Adding an explanation section to the documentation #633

consideRatio opened this issue Jul 3, 2023 · 0 comments

Comments

@consideRatio
Copy link
Member

The diatagix framework (https://diataxis.fr/) helps us with a description of a structure on what to document where. We are currently missing the explanation part, and I think we would benefit from it to offload other sections of the documentation.

For example, consider how to document the help string of OAuthenticator.authorize_url, OAuthenticator.userdata_url and OAuthenticator.token_url etc, it doesn't really make sense to do it in isolation, and neither does it make sense to do fully in either help strings. Instead what could make sense is to have a section explaining some OAuth stuff to the extent that we can just reference the explanation section that mentions these URLs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant