Compodoc (Frontend)
Disponible en GitHub Pages: https://fjbatresv.github.io/sdg19-final/compodoc/
Generar documentación local
Section titled “Generar documentación local”npx nx run web:docsSalida: dist/compodoc/web.
Validar cobertura de documentación
Section titled “Validar cobertura de documentación”npx nx run web:docs:coverage- Umbral global: >= 80%.
- Minimo por archivo: >= 25%.
- Compodoc falla el comando si no se alcanza el umbral.
- Para reducir ruido, sólo se listan los elementos con documentación faltante.
Validar todo (coverage + docs)
Section titled “Validar todo (coverage + docs)”npx nx run web:docs:checkGitHub Pages
Section titled “GitHub Pages”El sitio se publica en GitHub Pages bajo la ruta del repositorio:
https://<org>.github.io/<repo>/Para asegurar que el sitio funcione bajo subpath, el workflow aplica un patch
del <base href> usando tools/compodoc/patch-base.js.
- El workflow
docs-pages.ymlgenera Compodoc y lo publica en GitHub Pages. - En CI se valida la cobertura con
nx run web:docs:coverage.
Cómo corregir fallos de cobertura
Section titled “Cómo corregir fallos de cobertura”- Añade JSDoc (
/** ... */) a componentes, servicios y otros artefactos públicos de Angular. - Documenta métodos públicos y propiedades expuestas relevantes.