Flujo De Documentación¶
El sitio de documentación de este repositorio vive bajo docs/ y usa MkDocs Material.
Comandos principales¶
Modelo de contenido¶
docs/src/index.md: landing pagedocs/src/en/: árbol en inglésdocs/src/es/: árbol en españoldocs/src/overrides/: overrides compartidos del themedocs/src/assets/stylesheets/extra.css: estilos visuales
Guía de edición¶
Cuando agregues o actualices una página publicable:
- mantené alineados inglés y español
- preservá la misma jerarquía de navegación en ambos árboles
- preferí páginas orientadas a usuario bajo
user-docs/ - preferí páginas internas del repositorio bajo
developer-docs/odeveloper-docs/guides/
Guía de validación¶
Antes de considerar completos los cambios de documentación:
- ejecutá
make docs-build - revisá la landing page
- revisá
/en/y/es/ - verificá el switch de idioma del header y las tabs superiores
Notas¶
Note
Este repositorio sigue intencionalmente el mismo layout de MkDocs y el mismo lenguaje visual que productive-k3s, para que ambos proyectos se sientan parte de la misma familia de documentación.