Chris Dzombak

Why use GitHub Wikis?

I usually disable GitHub’s wikis on my repositories. I think they are occasionally useful, but I much prefer maintaining documentation as Markdown files in a folder inside the repository itself. This is why…

For inspiration, look at ReactiveCocoa’s Documentation folder. It has a home page and index as you’d expect, it remains in sync with the code, changes can be made and reviewed with the normal branch/PR model, relative links between files exist like you’d expect, and editing the files online is easy.


As always, I welcome discussion and feedback; I’m @cdzombak on Twitter.