Lista de comprobación de documentación de paquetes
Úsala al añadir o cambiar un paquete o su API pública.
- Propósito — Cuándo usarlo / cuándo no.
- Instalación — Línea
npm i; indica peers (normalmente@agentskit/corevía paquetes de funciones). - Superficie pública — Exportaciones principales alineadas con
src/index.ts(detalles en TypeDoc). - Configuración — Tablas de opciones para las fábricas principales.
- Ejemplos — Camino feliz + un ejemplo orientado a producción o a un caso límite.
- Integración — Enlaces a paquetes adyacentes (mantén la línea Ver también al pie de cada guía breve).
- Solución de problemas — FAQ corta (errores, variables de entorno, desalineación de versiones).
Cuando cambien las exportaciones, actualiza la guía y comprueba que pnpm --filter @agentskit/docs build sigue pasando (docs:api regenera TypeDoc).