Skip to content
SDG19 Final

Astro Starlight (portal principal)

El portal principal de documentación se construye con Astro Starlight y vive en docs-site/.

Desarrollo local

Section titled “Desarrollo local”
Terminal window
npm run docs:dev

Este comando sincroniza el OpenAPI hacia docs-site/public/openapi.yaml y levanta el servidor local.

Build estático

Section titled “Build estático”
Terminal window
npm run docs:build

Salida: dist/docs-site/.

Preview del build

Section titled “Preview del build”
Terminal window
npm run docs:preview

Base path en GitHub Pages

Section titled “Base path en GitHub Pages”

El sitio se publica bajo el subpath del repositorio. El workflow define ASTRO_BASE=/sdg19-final/ para generar rutas correctas en Pages.

Sincronizar OpenAPI

Section titled “Sincronizar OpenAPI”
Terminal window
npm run docs:sync-openapi

Si el contrato cambia, ejecuta la sincronización antes del build.

Actualización de contenido

Section titled “Actualización de contenido”
  • Mantén docs-site/ alineado con README.md, ARCHITECTURE.md y FLOWS.md.
  • Actualiza los diagramas Mermaid cuando cambie el flujo de correos o data lake.