sw-toolbox
sw-toolbox copied to clipboard
Auto-generate documentation
The current hardcoded Markdown documentation is fragile and there aren't any enforced standards. One of the options described at http://stackoverflow.com/questions/15694267/how-to-easily-create-github-friendly-markdown-for-documented-javascript-function might be a better choice.
On Propel I configured Travis to push docs when ever an update is made to master:
https://github.com/GoogleChrome/Propel/blob/master/.travis.yml
script:
- npm test
- npm run build-docs
- sh ./project/publish-docs.sh
It essentially used npm script to run esdoc (what is being used for sw-toolbox at the moment?) and then the publish-docs shell script force push the docs to gh-pages.
Only thing this doesn't account for (and it should do) is keep docs for the last tagged release.
esdoc seems like a good tool to standardize on. The prerequisite to automating a build process is writing the corresponding JSDoc comments, which don't currently exist, and which this bug is also meant to track.
Got you :) Will try setting up PRs for Docs and tests as I go.
This is in place now for master.
Need to get sw-toolbox up and running with releases next.