The GitHub wiki is an anti-pattern
A developer argues GitHub wikis are an anti-pattern versus versioned docs in /docs.
A developer opinion piece argues that GitHub project wikis are an anti-pattern compared with documentation stored in a repository /docs folder. The author says folder-based docs stay versioned with code, are available on clone, and can go through pull-request review and linting. Suggested publishing options include GitHub Pages with the just-the-docs theme or a custom build such as Hugo.
- Vendors
- GitHub
- Products
- GitHub WikiGitHub Pages
- Organizations
- GitHub
From the original article
2 min read at michaelheap.com
The “ should I use the wiki or a docs folder on GitHub? ” discussion comes up every 6 months or so, and following Shawn Wang’s three strikes rule I thought it was about time I wrote something down about it.
By ibobev · michaelheap.com
A short excerpt; the article and its images belong to the publisher. Summary, key facts and assessment above are AI-written from the article and can be wrong.