La discusión de "¿debo usar el wiki o una carpeta docs en GitHub?" resurge cada pocos meses. Siguiendo la regla de tres strikes de Shawn Wang, el autor argumenta que usar el wiki en GitHub es un anti-patrón. El único beneficio del wiki es su disponibilidad constante, pero carece de versionado, acceso local, revisión por pares y opciones de marca.

En cambio, una carpeta /docs integra la documentación con el código, soporta versionado, habilita revisiones de pull request y funciona con herramientas como Vale y corrector ortográfico. Las imágenes deben alojarse en otro lugar ya que el wiki no soporta subidas. Para publicar docs, usa una carpeta /docs con GitHub Pages y un tema como just-the-docs.

Evita la rama gh-pages para mantener los docs versionados con el código. A medida que los proyectos crecen, los docs pueden moverse a un repo separado, pero los contribuyentes ya estarán acostumbrados al flujo de trabajo. El autor invita a comentarios en Twitter.