Guía de contribución
Cómo agregar y organizar documentación en este sitio.
Agregar un documento a un área existente
- Ubica la carpeta del área en
documents/<area>/. - Crea tu archivo
.md/.mdx(usa la Plantilla de documento). - Para agrupar por tema, crea una subcarpeta — se vuelve una categoría colapsable en el menú de forma automática.
- Verifica el resultado con
npm start(servidor local) onpm run build.
Organización por área
La navegación está organizada por área de la empresa (Web, Realidad Aumentada,
Unity, Arte 3D, UI/UX, I.A, Investigaciones, Proyectos, General). Cada área es una
carpeta bajo documents/ registrada como instancia de documentación.
Agregar un área nueva
En docusaurus.config.js todo
se controla desde un solo lugar:
- Agrega un objeto al arreglo
docsAreasconid,pathyroute(nombre en minúsculas, sin espacios). Esto registra la instancia de docs y la indexa en el buscador automáticamente. - Crea la carpeta
documents/<area>/con unintro.md(obligatorio: el enlace del navbar apunta a/documents/<area>/intro). - Agrega el ítem correspondiente en
themeConfig.navbar.items(enlace directo o dentro de undropdownpor área).
Categorías: _category_.json
Para controlar la etiqueta, el orden y la descripción de una subcarpeta, agrega un
_category_.json:
{
"label": "Nombre visible",
"position": 2,
"link": { "type": "generated-index", "description": "De qué trata esta categoría." }
}
Buenas prácticas
- Escribe en español.
- Un documento = un tema. Divide si crece demasiado.
- Imágenes en
img/junto al documento, con rutas relativas. - Revisa los enlaces internos manualmente:
onBrokenLinksestá enignore, por lo que un enlace roto no falla el build (solo hace 404 en el sitio).