Documentation
LB-- opened this issue · 3 comments
What sort of documentation should be used? We could use in-code documentation via Doxygen, or we could use the wiki on this repository.
Personally I would prefer a combination of both, as Doxygen is quite powerful for generating graphs, displaying relationships, etc. and the wiki on this repository would be a great place to help get people familiar with the code base by explaining the basic workings of the design.
Agreed. Doxygen is really powerful and useful.
afaik, you can push doxygen html files to github gh-pages as well.
afaik, you can push doxygen html files to github gh-pages as well.
Yes, but I don't have push access to this repo so you or naraku would have to run the command yourself (the GitHub app can't do it):
git checkout --orphan gh-pages
git rm -rf .Then add the generated files (in this case just add a file named ".gitkeep" as a stub)
git add .gitkeep
git commit -m "Add gh-pages branch"
git push origin +gh-pagesIf you are using the GitHub app, you will need to have it stop tracking the repo, delete the repo, and clone it again - otherwise it won't be able to handle what you've done. This is definitely a bug and I am sure it is reported, but it hasn't been fixed yet.
Another useful thing is being able to tag commits with versions. It would help to tag commits on the gh-pages branch to correlate them with commits on the master branch, otherwise you would have to look at dates. Unfortunately tags don't follow Pull Requests, so someone with push access would have to do it.
Just an update for those who don't know: the gh-pages branch will be for the end-user part of the game, and the documentation will just be generated from the source at your demand on your computer.