View Single Post
Old 04-14-2013, 12:47 PM   #125
eureka
but forgot what it's like
eureka ought to be getting tired of karma fortunes by now.eureka ought to be getting tired of karma fortunes by now.eureka ought to be getting tired of karma fortunes by now.eureka ought to be getting tired of karma fortunes by now.eureka ought to be getting tired of karma fortunes by now.eureka ought to be getting tired of karma fortunes by now.eureka ought to be getting tired of karma fortunes by now.eureka ought to be getting tired of karma fortunes by now.eureka ought to be getting tired of karma fortunes by now.eureka ought to be getting tired of karma fortunes by now.eureka ought to be getting tired of karma fortunes by now.
 
Posts: 741
Karma: 2345678
Join Date: Dec 2011
Location: north (by northwest)
Device: Kindle Touch
Another one suggestion: write user manual with the help of Sphinx and maintain it in source tree. There is a free service Read The Docs for hosting Sphinx-based documentation. It includes deep integration with GitHub and automatic update of documentation on every commit (with the help of GitHub webhook). It also compiles documentation into PDF and EPUB formats.

There are downsides, of course. It will require Python for local testing of documentation, learning of Sphinx for documentation setup and learning of reStructuredText for documentation writing (however, reStructuredText is close to Markdown).

I understand that user manual writing isn't a priority for now and GitHub wiki is pretty fine suited for current needs. Just wanted to describe one of other possible variants.
eureka is offline   Reply With Quote