Skip to content

Astro Starlight (portal principal)

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

Terminal window
npm run docs:dev

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

Terminal window
npm run docs:build

Salida: dist/docs-site/.

Terminal window
npm run docs:preview
  • / y /es/: landing de portafolio (páginas Astro en src/pages/).
  • /docs/: esta documentación (contenido en src/content/docs/docs/).
  • /compodoc/ y /api-typedoc/: sitios generados por Compodoc y TypeDoc.
  • Las URLs anteriores (/portfolio/, /deploy/, /infra/...) redirigen a la nueva ubicación (redirects en astro.config.mjs).

El workflow docs-pages.yml calcula ASTRO_BASE/ASTRO_SITE:

  • Sin la variable de repositorio PAGES_CUSTOM_DOMAIN: el sitio vive bajo /sdg19-final/ en fjbatresv.github.io.
  • Con PAGES_CUSTOM_DOMAIN=sdg19.fjbatresv.com: base / en ese dominio.
  1. DNS de fjbatresv.com: registro CNAME sdg19 → fjbatresv.github.io.
  2. Variable de repositorio: gh variable set PAGES_CUSTOM_DOMAIN --body sdg19.fjbatresv.com.
  3. Settings → Pages → Custom domain sdg19.fjbatresv.com (o gh api -X PUT repos/<owner>/<repo>/pages -f cname=sdg19.fjbatresv.com) y, cuando el certificado esté listo, Enforce HTTPS.
  4. Re-ejecuta el workflow Docs (Starlight + Compodoc).
Terminal window
npm run docs:sync-openapi

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

  • 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.