search

Kinto / kinto.js

An Offline-First JavaScript Client for Kinto.
http://kintojs.readthedocs.io/
Other
318 stars 71 forks source link

Publish documentation on gh-pages branch #1753

Open dstaley opened 5 years ago

dstaley commented 5 years ago

Right now both kinto-http.js and kinto.js use doc.esdoc.org to publish their documentation. ESDoc is, unfortunately, not very TypeScript friendly, so I've been planning on switching over to TypeDoc. However, we'll need a place to host the documentation.

Currently, the gh-pages branch contains the demo for the two projects. I propose that we publish the TypeDoc generated documentation to the gh-pages branch using a GitHub Action when we tag a non-pre-release from master. I haven't looked into it yet, but I'm fairly sure we could still host the demo as a part of the generated TypeDoc documentation.

@leplatrem What do you think?

leplatrem commented 5 years ago

Sounds good!

We can do something with folders too I guess... (eg. https://kinto.github.io/kinto-http.js/demo/)

dstaley commented 4 years ago

Adding a note here so I don't lose it: https://github.com/JamesIves/github-pages-deploy-action/blob/dev/entrypoint.sh

While we could use someone else's action, I'd prefer to keep a copy of the script in the repo so we know it's not doing anything nefarious.