Manual de usuario — Sonata

Documentación de usuario del sistema Sonata / Sonata. Generada con VitePress.

Estructura

manual/
├── .vitepress/config.js      # Configuración: sidebar, nav, búsqueda
├── public/img/<modulo>/      # Capturas de pantalla (pendiente de poblar)
├── guide/                    # Primeros pasos (6 páginas)
├── ventas/                   # Facturas, COT, PED, cobros, DEV, recurrentes, GC, precios/descuentos, turnos
├── fiscal/                   # FEL / DGI Panamá (multi-PAC, anulación DGI-primero, ZIP mensual)
├── compras/                  # FCP, OC, pagos, gastos, proveedores
├── inventario/               # Existencias, ajustes, productos, variantes
├── clientes-marketing/       # Clientes 360°, cupones, campañas
├── reportes/                 # Catálogo de reportes (espejo del hub /reports)
├── contabilidad/             # Libro diario, mayor, balance, EEFF, plan cuentas
├── salud/                    # Agenda, salas de espera, clínica, documentos clínicos, aseguradoras, laboratorio
└── administracion/           # Usuarios, roles, invitaciones, configuración, bitácora, importación

Comandos

# Instalar dependencias (solo la primera vez)
npm install

# Servidor de desarrollo con hot-reload
npm run docs:dev
# → http://localhost:5173

# Build de producción
npm run docs:build
# Resultado en manual/.vitepress/dist/

# Preview del build de producción
npm run docs:preview

Cómo contribuir

Editar una página existente

1. Abre el archivo .md de la sección que quieres editar.
2. Edita el contenido en Markdown estándar.
3. Verifica con npm run docs:dev que el resultado se ve bien.
4. Haz commit.

Agregar una página nueva

1. Crea el archivo .md en la carpeta del módulo correspondiente.
2. Agrégalo al sidebar en manual/.vitepress/config.js (sección themeConfig.sidebar).
3. Enlázalo desde la página index.md del módulo.
4. Verifica con npm run docs:dev.

Agregar capturas de pantalla

Las imágenes van en manual/public/img/<modulo>/ (se sirven como /img/<modulo>/archivo.png).

Ejemplo en Markdown:

![Formulario de nueva factura](/img/ventas/factura-nueva.png)

Usa capturas en formato PNG, ancho recomendado 1200 px, sin datos personales reales.

Callouts de VitePress

Úsalos para destacar información importante:

::: tip Consejo
Texto de ayuda opcional.
:::

::: info
Información neutral.
:::

::: warning Importante
Advertencia que el usuario debe leer.
:::

::: danger Error común
Algo que puede causar problemas si se omite.
:::

Fases pendientes

Fase	Estado	Descripción
A	✅	Scaffolding VitePress + guide/ + ventas/facturas modelo
B	✅	Contenido completo: ventas, compras, inventario, clientes, fiscal, contabilidad
C	✅	Fiscal/FEL setup, libro diario expandido
D	✅	Salud expandido: turnos médicos, documentos clínicos, aseguradoras (2026-07-20)
E	🔲	Capturas de pantalla reales en public/img/

Nota de deploy: el build compila a public/docs/ y viaja con el repo, así que en producción se sirve como estáticos bajo /docs/ sin servicio adicional (la antigua fase F "docs.tudominio.com" quedó reemplazada por este esquema).

Sincronización con la app (2026-07-20)

Última revisión completa módulo por módulo contra el estado real de la app (commits hasta 88625c5). Al agregar features nuevas al sistema, actualizar la página del módulo correspondiente y correr npm run docs:build antes del commit para que public/docs/ no quede desfasado.