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

Clean up the "components" documentation #77

Open
shevron opened this issue Mar 2, 2021 · 0 comments
Open

Clean up the "components" documentation #77

shevron opened this issue Mar 2, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@shevron
Copy link
Contributor

shevron commented Mar 2, 2021

Now that we have written some howto guides / tutorials as part of #72 and #73, we should clean up the docs around Transfer adapters, Storage backends and Auth providers to make them more concise.

I'm thinking that each should be composed of a more "reference" style section, detailing each component type and each of the available options, and a "discussion" style section discussing design and abstractions.

Maybe, content that relates to creating custom components (if we have anything like that at all) should be moved to the development guide.

@shevron shevron added the documentation Improvements or additions to documentation label Mar 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant