Update the documentation - Githubissues

voila-dashboards / voici

Voici turns any Jupyter Notebook into a static web application

https://voici.readthedocs.io/

Other

145 stars 8 forks source link

Update the documentation #60

Closed jtpio closed 1 year ago

jtpio commented 1 year ago

References

Fixes https://github.com/voila-dashboards/voici/issues/4

Code changes

[x] Convert the docs to Markdown
[x] Update config
[x] Add scripts to easily build the docs locally
[x] Add a get started guide
[x] Mention the demo repo: https://github.com/voila-dashboards/voici-demo
[x] Include live demo (check if jupyterlite-sphinx would work)

User-facing changes

The documentation should be improved.

Preview: https://voici--60.org.readthedocs.build/en/60/
Voici demo app: https://voici--60.org.readthedocs.build/en/60/_static/lite/voici/tree/index.html

Backwards-incompatible changes

None

jtpio commented 1 year ago

Stopping here for now. We can always iterate in follow-up PRs.