search

wilk / microjob

A tiny wrapper for turning Node.js worker threads into easy-to-use routines for heavy CPU loads.
https://wilk.github.io/microjob/
MIT License
2.02k stars 47 forks source link

consider moving compiled docs to gh-pages branch? #21

Closed larshp closed 6 years ago

larshp commented 6 years ago

Hi, Currently the master branch contains both the raw documentation(.md files) and compiled documentation(docs folder).

Consider moving the docs folder to gh-pages branch, this way there will only be one set of original files in the master branch and less updates.

https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/

wilk commented 6 years ago

Well, Github allows you to have the docs on master and I don't see a real benefit moving the compiled docs to gh-pages. However, I think it could be useful to have a "Contribute" section to instruct the contributor on how to update the docs.

larshp commented 6 years ago

okay