Saltar al contenido principal

Guía de contribución

Cómo agregar y organizar documentación en este sitio.

Agregar un documento a un área existente

  1. Ubica la carpeta del área en documents/<area>/.
  2. Crea tu archivo .md / .mdx (usa la Plantilla de documento).
  3. Para agrupar por tema, crea una subcarpeta — se vuelve una categoría colapsable en el menú de forma automática.
  4. Verifica el resultado con npm start (servidor local) o npm 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:

  1. Agrega un objeto al arreglo docsAreas con id, path y route (nombre en minúsculas, sin espacios). Esto registra la instancia de docs y la indexa en el buscador automáticamente.
  2. Crea la carpeta documents/<area>/ con un intro.md (obligatorio: el enlace del navbar apunta a /documents/<area>/intro).
  3. Agrega el ítem correspondiente en themeConfig.navbar.items (enlace directo o dentro de un dropdown por á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: onBrokenLinks está en ignore, por lo que un enlace roto no falla el build (solo hace 404 en el sitio).