refactor: migrar reportes a Typst con plantilla compartida y scripts

- Reemplazar plantillas Markdown por template/report.typ y template/main.typ
- Agregar primer reporte: respuesta-observaciones-avance-1
- Agregar scripts build.sh, preview.sh y common.sh con salida en pdf/
- Actualizar README y AGENTS.md; simplificar .gitignore
This commit is contained in:
2026-10-28 09:53:53 -03:00
parent d5030bdc0d
commit 2009e91465
15 changed files with 310 additions and 112 deletions
+36 -33
View File
@@ -1,42 +1,45 @@
# Reportes
# Reportes FONDEF IT24I0091 Manito
Repositorio central de reportes del equipo. Cada reporte se genera a partir de una
plantilla y se archiva según su tipo, de modo que el historial quede ordenado y sea
fácil encontrar versiones anteriores.
Reportes en [Typst](https://typst.app) con una plantilla compartida en
`template/report.typ`. Requiere Typst (probado con 0.15.1) y Bash; para la vista
previa, un visor de PDF predeterminado.
## Estructura
`template/` contiene solo la plantilla y el documento base reutilizable.
Los scripts no generan PDF de las plantillas; cópielas a `reports/` para usarlas.
`reports/` contiene los reportes, cada uno en su propia carpeta.
El primero es `reports/respuesta-observaciones-avance-1/main.typ`, con el título
interno «RESPUESTA OBSERVACIONES INF. DE AVANCE 1».
```text
.
├── README.md # esta guía
├── .gitignore # archivos ignorados por Git
├── plantillas/ # plantillas para crear nuevos reportes
│ └── plantilla-reporte.md
├── reportes/ # reportes archivados, uno por carpeta
│ ├── semanal/
│ ├── mensual/
│ ├── hito/
│ └── final/
└── assets/ # imágenes y binarios embebidos en los reportes
## Compilar y ver
```bash
./scripts/build.sh # compila solo si no existe el PDF
./scripts/preview.sh # abre el PDF existente; lo crea si falta
./scripts/build.sh --force # regenera el PDF aunque exista
./scripts/preview.sh --force # regenera, abre y recompila al guardar
./scripts/build.sh reports/respuesta-observaciones-avance-1
./scripts/preview.sh reports/respuesta-observaciones-avance-1/main.typ
```
## Tipos de reporte
Ambos scripts aceptan un archivo `.typ` o una carpeta con `main.typ`. Los PDF se
guardan en `pdf/` en la raíz, con el nombre del reporte: por ejemplo,
`pdf/respuesta-observaciones-avance-1.pdf`. Para `main.typ` se usa el nombre de
su carpeta; para otros archivos, el nombre del archivo sin `.typ`.
El PDF se conserva aunque cambien los fuentes. Para
actualizarlo, use `--force` (o `-f`). Las rutas relativas parten del directorio
actual; los scripts configuran la raíz de Typst automáticamente. Use Ctrl+C para
detener la vista previa con `--force`.
| Tipo | Carpeta | Descripción |
| --- | --- | --- |
| Semanal | `reportes/semanal/` | Avance de la semana: tareas, bloqueos, próximos pasos. |
| Mensual | `reportes/mensual/` | Resumen del mes con métricas y estado general. |
| Hito | `reportes/hito/` | Cierre de un hito o entregable del proyecto. |
| Final | `reportes/final/` | Informe final del proyecto. |
## Crear un reporte
## Cómo agregar un reporte
```bash
mkdir -p reports/nombre-corto/figures
cp template/main.typ reports/nombre-corto/main.typ
```
1. Copia `plantillas/plantilla-reporte.md` a la carpeta de su tipo.
2. Nombra el archivo `AAAA-MM-DD-<slug>.md`, por ejemplo `2026-10-28-semana-44.md`.
3. Completa la tabla de metadatos (frontmatter) y el contenido.
4. Guarda las imágenes en `assets/` y referéncialas desde el reporte.
Edite los datos de `report.with(...)` y el contenido de `main.typ`. Guarde las
imágenes en `figures/` y use nombres de carpeta cortos, en minúsculas y con guiones.
Los PDF no se versionan; las entregas se guardan en Google Drive.
## Agregar un nuevo tipo de reporte
Crea una carpeta en `reportes/<nuevo-tipo>/` con su propio `README.md` describiendo
el formato, y copia la carpeta de un tipo existente como base.
Las reglas para agentes están en [AGENTS.md](AGENTS.md): los commits y pushes
requieren una solicitud explícita del usuario.