Documentation
Opened this issue · 3 comments
What tools should we use for generating documentation? What should the docs contain?
doxygen, maybe? IMO, should just contain class references to everything. and maybe a few examples to get people used to working with the doc.
You can find a good Beginner's Guide here: http://www.writethedocs.org/guide/writing/beginners-guide-to-docs/
About the tools, Github Pages itself manage to render pages in HTML from Markdown using the Jekyll engine. It's an option for your repository to turn on.
The problem with Jekyll is that it means we have to separate the docs and code - it isn't really useful to people who have IDEs which can display documentation while working on code using disccord.
I think doxygen would probably be the smartest route, and we could probably use GitHub pages to host the docs (maybe add a build step to Travis to push back doxygen stuff after a successful build?)