Desarrollo

Mantener la documentación

Mantén las páginas alineadas con el producto y valida el sitio de documentación.

La documentación está separada del repositorio del producto. No debe deducir el estado de una función a partir de la landing o de la demo.

Fuentes prioritarias

  1. Código y pruebas de projets/tradoc.
  2. Salida actual de los comandos --help.
  3. .env.example, Dockerfile y archivos de Compose.
  4. Interfaz del producto.
  5. README, después de contrastarlo con el código.

Validación

npm run check:content
npm run check:links
npm run lint
npm run typecheck
npm run build

Cuando cambia el producto

  • Nuevo proveedor: actualizar proveedores y pruebas de conexión.
  • Nuevo formato: documentar extracción, vista previa, reconstrucción y tipo MIME.
  • Nueva variable: añadir valor predeterminado, límites e implicaciones de seguridad.
  • Nuevo comando: ejecutar --help antes de publicar su sintaxis.
  • Nuevo dominio: presentarlo como activo solo después de una comprobación HTTPS real.

Mantenimiento de los cuatro idiomas

El inglés es canónico. Cada página inglesa debe tener versiones completas en francés, español y alemán antes de publicarse. Un cambio de producto que afecte a la documentación actualiza los cuatro archivos en el mismo pull request; ningún idioma puede volver silenciosamente al inglés ni figurar como traducido si está desactualizado.

Markdown para asistentes

Cada página ofrece un Markdown procesado desde su menú. Se genera a partir del mismo MDX localizado para evitar una segunda documentación divergente.