Saltar a contenido

ADR 0001 - Documentación como código

Estado

Aceptado.

Contexto

Los proyectos están en repositorios separados, con documentación desigual: algunos tienen AGENTS.md, README.md, CHANGELOG.md y docs/, mientras que otros solo tienen el README por defecto del framework. Además, el directorio local de trabajo no es un repositorio Git, por lo que no existe un punto de entrada versionado para el equipo.

Decisión

  1. Crear un repositorio central vortex-play-docs como hub de documentación transversal.
  2. Mantener la documentación de detalle en cada repositorio.
  3. Estandarizar un README mínimo por proyecto.
  4. Publicar el hub como sitio estático con MkDocs Material.
  5. Registrar las decisiones importantes como ADR.
  6. Tratar HANDOFF.md como documento temporal; la información durable se mueve a docs/.

Consecuencias

  • Hay un único punto de entrada para nuevos programadores.
  • La documentación de detalle sigue cerca del código.
  • Se evita duplicar información, pero requiere disciplina para mantener los enlaces.
  • Los repositorios deben actualizar su documentación en la misma PR que cambia el comportamiento.