Die Diskussion „Soll ich das Wiki oder einen docs-Ordner auf GitHub verwenden?“ taucht alle paar Monate wieder auf. Gemäß Shawn Wangs Three-Strikes-Regel argumentiert der Autor, dass die Nutzung des Wikis auf GitHub ein Anti-Pattern ist. Der einzige Vorteil des Wikis ist seine ständige Verfügbarkeit, aber es fehlen Versionierung, lokaler Zugriff, Peer-Review und Branding-Optionen.

Im Gegensatz dazu integriert ein /docs-Ordner die Dokumentation mit dem Code, unterstützt Versionierung, ermöglicht Pull-Request-Reviews und funktioniert mit Tools wie Vale und Rechtschreibprüfung. Bilder müssen woanders gehostet werden, da das Wiki keine Uploads unterstützt. Um Docs zu veröffentlichen, nutzen Sie einen /docs-Ordner mit GitHub Pages und einem Theme wie just-the-docs.

Vermeiden Sie den gh-pages-Branch, um Docs versioniert mit dem Code zu halten. Wenn Projekte wachsen, können Docs in ein separates Repo verschoben werden, aber Contributors sind dann bereits an den Workflow gewöhnt. Der Autor lädt zu Feedback auf Twitter ein.