hiebj / stately

elegant, type-safe state management
2 stars 1 forks source link

get typedocs posted up on github pages #1

Closed hiebj closed 5 years ago

hiebj commented 5 years ago

we want the TypeDoc API docs to be readable from the web, and linkable in the README/example snippets.

I actually don't know how gh-pages works, but it should be fairly trivial to run typedoc on the entire project. (currently it is run on a per-module basis). TypeDoc may be ugly, but it converts JSDoc into web pages and that's what matters. (maybe someday we can write a TypeDoc theme that actually looks good).

A pattern should also be established for regenerating/updating the docs - perhaps as a precommit hook or similar. It is not completely out of the question that the generated docs be tracked in version control (after all, I think they need to exist in a branch somewhere to get them hosted on github pages anyway).

Once this is done, there is really no reason to continue generating them on a per-module basis and publishing them with the node module artifact - it's just extra bloat. The README links should work from anywhere.

so:

hiebj commented 5 years ago

done. there's no automated process for rerunning the docs script for now, so it has to be rerun manually if the API or README changes.