HeadlinesBriefing favicon HeadlinesBriefing.com

Anti-pattern GitHub Wiki : utilisez /docs au lieu du Wiki

Hacker News •
×

La discussion « faut-il utiliser le wiki ou un dossier docs sur GitHub ? » refait surface tous les quelques mois. Suivant la règle des trois strikes de Shawn Wang, l'auteur soutient qu'utiliser le wiki sur GitHub est un anti-pattern. Le seul avantage du wiki est sa disponibilité constante, mais il manque de versioning, d'accès local, de revue par les pairs et d'options de branding.

En revanche, un dossier /docs intègre la documentation au code, prend en charge le versioning, active les revues de pull request et fonctionne avec des outils comme Vale et la correction orthographique. Les images doivent être hébergées ailleurs car le wiki ne prend pas en charge les téléversements. Pour publier la doc, utilisez un dossier /docs avec GitHub Pages et un thème comme just-the-docs. Évitez la branche gh-pages pour garder la doc versionnée avec le code.

Au fur et à mesure que les projets grandissent, la doc peut passer dans un dépôt séparé, mais les contributeurs seront déjà habitués au flux de travail. L'auteur invite aux commentaires sur Twitter.