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

Document the new library usage (import/require/global/... + new widget) #972

Closed
raucao opened this issue Apr 17, 2017 · 4 comments
Closed
Assignees
Labels
Milestone

Comments

@raucao
Copy link
Member

raucao commented Apr 17, 2017

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.

@raucao raucao added the docs label Apr 17, 2017
@raucao raucao added this to the Version 1.0 milestone Apr 17, 2017
@raucao raucao added the ready label Apr 18, 2017
@galfert
Copy link
Member

galfert commented Apr 28, 2017

Also document that users need to bring their own polyfill for promises now if they want to support older browsers.

@raucao
Copy link
Member Author

raucao commented Aug 25, 2017

I learned how Read the Docs works, and created a basic Sphinx setup with the RtD theme for our doc folder. I also converted the first two files to .rst in there, and thought about how to structure the docs. There's a special Contributing section now, so we can keep information for contributors seperate from library usage docs for app developers for example (and thus also create way more docs for contributing).

Currently pushing to a docs/sphinx branch.

@raucao
Copy link
Member Author

raucao commented Aug 25, 2017

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).

@raucao
Copy link
Member Author

raucao commented Aug 25, 2017

Last update for today: I converted all existing files in doc to RST now (pandoc FTW!) and added all of them to the menu: https://remotestoragejs.readthedocs.io/en/docs-sphinx/

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.

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

No branches or pull requests

2 participants