Using the wiki on GitHub makes life more difficult for your users, and you as a maintainer. Use the `/docs` folder and GitHub Pages instead and keep your docs in sync with code
Hmm, good points. Looking at it now, it feels like a feature that only makes sense for proprietary projects, where you want to document specific customer use-cases (which don’t make much sense to version with your code), and where you have project owners that are scared of Git.
I really can’t think of many use-cases for open-source projects. Even if it doesn’t have to be versioned, you would still check it in via Git, because that’s just where your project lives.
I mean, I do know open-source projects with a MediaWiki instance, such as DCSS, but the entire point of those is to allow contributions from random users, not just the devs. And I assume, that’s not how the GitHub Wiki feature works (never actually seen any project use it, though, so I might be wrong).
Hmm, good points. Looking at it now, it feels like a feature that only makes sense for proprietary projects, where you want to document specific customer use-cases (which don’t make much sense to version with your code), and where you have project owners that are scared of Git.
I really can’t think of many use-cases for open-source projects. Even if it doesn’t have to be versioned, you would still check it in via Git, because that’s just where your project lives.
I mean, I do know open-source projects with a MediaWiki instance, such as DCSS, but the entire point of those is to allow contributions from random users, not just the devs. And I assume, that’s not how the GitHub Wiki feature works (never actually seen any project use it, though, so I might be wrong).