-
Notifications
You must be signed in to change notification settings - Fork 140
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
Document the new library usage (import/require/global/... + new widget) #972
Comments
Also document that users need to bring their own polyfill for promises now if they want to support older browsers. |
I learned how Read the Docs works, and created a basic Sphinx setup with the RtD theme for our Currently pushing to a |
I signed up for Read the Docs and imported the branch, so it should be built automatically when pushing to that now: https://remotestoragejs.readthedocs.io/en/docs-sphinx/ The "edit on GitHub" link is currently broken, because it has issues with slashes in branch names (they're converted to dashes over there). |
Last update for today: I converted all existing files in Automatic builds on push work like a charm, so anyone can now edit and create docs in that branch. I think the next step would be adding a new "getting started" section and afterwards seeing how much of the existing content is still useful when editing it and what has to be deleted or rewritten entirely. |
I think this should finally be done in the generated API docs, which are currently missing the whole intro for how to use the library.
The text was updated successfully, but these errors were encountered: