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”npm run docs:devEste comando sincroniza el OpenAPI hacia docs-site/public/openapi.yaml y
levanta el servidor local.
Build estático
Section titled “Build estático”npm run docs:buildSalida: dist/docs-site/.
Preview del build
Section titled “Preview del build”npm run docs:previewEstructura y base path en GitHub Pages
Section titled “Estructura y base path en GitHub Pages”/y/es/: landing de portafolio (páginas Astro ensrc/pages/)./docs/: esta documentación (contenido ensrc/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 (redirectsenastro.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/enfjbatresv.github.io. - Con
PAGES_CUSTOM_DOMAIN=sdg19.fjbatresv.com: base/en ese dominio.
Activar el dominio propio
Section titled “Activar el dominio propio”- DNS de
fjbatresv.com: registroCNAMEsdg19→fjbatresv.github.io. - Variable de repositorio:
gh variable set PAGES_CUSTOM_DOMAIN --body sdg19.fjbatresv.com. - Settings → Pages → Custom domain
sdg19.fjbatresv.com(ogh api -X PUT repos/<owner>/<repo>/pages -f cname=sdg19.fjbatresv.com) y, cuando el certificado esté listo, Enforce HTTPS. - Re-ejecuta el workflow Docs (Starlight + Compodoc).
Sincronizar OpenAPI
Section titled “Sincronizar OpenAPI”npm run docs:sync-openapiSi 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 conREADME.md,ARCHITECTURE.mdyFLOWS.md. - Actualiza los diagramas Mermaid cuando cambie el flujo de correos o data lake.