The GitHub wiki is an anti-pattern

The ongoing debate about utilizing GitHub wikis or documents folders for project documentation has resurfaced approximately every six months. Drawing inspiration from Shawn Wang's three strikes rule, this article aims to shed light on the subject. Initially, the post began with a neutral stance, suggesting both wiki and document folders as viable options, but as it progressed, the author discovered a singular reason to adopt a wiki, while numerous drawbacks exist.

So profound are these drawbacks that the author considers employing a wiki on GitHub an "anti-pattern."

The primary advantage of using a wiki, according to the author, is its constant availability. Once the decision is made to store documentation alongside the code, the question arises as to how to facilitate easy access for users. Keeping documentation in a dedicated "/docs" folder is considered the most efficient approach during the initial stages of product development.

However, as documentation expands beyond a single folder, it becomes increasingly challenging to manage. At this juncture, the author advocates for a separate repository equipped with its own build process, pull request review guidelines, and other necessary components. This transition from "/docs" to a distinct repository is expected to be smooth for contributors who have become accustomed to working with documentation within a repository.