wiki icon indicating copy to clipboard operation
wiki copied to clipboard

Research open source documentation tools

Open hswick opened this issue 6 years ago • 3 comments

Determine best practices and tools for open source documentation

hswick avatar Mar 22 '18 01:03 hswick

This seems like the best option: https://blog.github.com/2016-08-22-publish-your-project-documentation-with-github-pages/

That way others can make PR's to the documentation

hswick avatar Mar 22 '18 18:03 hswick

Good model to base off of https://github.com/ethereum/wiki/wiki

hswick avatar Mar 27 '18 15:03 hswick

Hudson suggested taking a look at http://ethdocs.org/en/latest/

Which uses https://readthedocs.org/

As the amount of docs grows this may be good for scaling, but read the docs has its own format to get used to

hswick avatar Apr 09 '18 18:04 hswick