Mantenimiento
Cómo mantener esta documentación alineada con el SDK, release flow y repos relacionados.
Esta documentación es humana y curada. No es output generado.
Fuente de verdad
Cuando cambie comportamiento público, actualiza primero Cartamatic/pos-sdk y sus docs fuente. Esta web refleja esa superficie pública.
Orden correcto de cambios
Cuando cambie comportamiento público del SDK:
Actualizar SDK
Actualiza implementación y docs fuente en Cartamatic/pos-sdk.
Validar SDK y skill
Ejecuta validaciones del SDK y regenera o valida pos-sdk-skill si afecta consumo público.
Actualizar documentación humana
Refleja el cambio en pos-sdk-docs, revisa visualmente y ejecuta validación local.
Deploy
Deploya y verifica producción en Vercel.
Cambios que exigen actualizar docs
API pública
Nuevos exports, tipos, métodos, opciones o retornos.
Errores y seguridad
Nuevas clases de error, metadata, logging o redacción.
Eventos y providers
Nuevos webhooks, providers o capabilities.
Operación
Cambios en release flow, generación de skill o deploy.
Validación local de esta doc
pnpm validateTambién revisar con Chrome DevTools:
//docs/docs/referencia-api- vista mobile
- sidebar
- búsqueda
- tablas
- code blocks
- consola/network
Deploy
La URL productiva es:
https://pos-sdk.cartamatic.appEl proyecto Vercel es pos-sdk-docs bajo el team Cartamatic.
Seguridad
No agregar a este repo:
- credenciales POS
- tokens GitHub/Vercel/npm
- raw captures
- customer data
- webhook secrets
Si necesitas documentar nombres de variables, usa placeholders vacíos o ejemplos no secretos.