Cómo está organizada esta documentación
Esta documentación está organizada con el framework Diátaxis. Diátaxis observa que la documentación técnica sirve a cuatro necesidades distintas, y que mezclarlas empeora los docs para todos. Por eso la parte superior de la barra lateral son cuatro modos, no una lista de funciones del producto:
| Modo | Orientación | Responde | Cuando estás… |
|---|---|---|---|
| Tutoriales | aprendizaje | “Llévame de cero a un resultado funcional.” | nuevo, y quieres aprender haciendo |
| Guías how-to | una tarea | “¿Cómo logro esta cosa concreta?” | trabajando, y necesitas una receta |
| Referencia | información | “¿Qué son exactamente la API, los eventos, los módulos, los flags?” | construyendo sobre ello, y necesitas precisión |
| Explicación | comprensión | “¿Por qué está construido así?” | evaluando, y quieres el razonamiento |
Un mapa rápido de dónde vive cada cosa:
- Tutoriales — los caminos de aprendizaje: de cero a un grafo de acceso de lectura/escritura, y empezar por escenario real — nodo único, Docker Compose, Kubernetes, air-gapped.
- Guías how-to — instalar y operar (self-host, backup y restauración, monitorización, troubleshooting), las guías por conector (pgAudit, CloudTrail, eBPF, Claude Code, MCP, identidad), y el cookbook de recetas de gobierno (políticas deny-closed, presupuestos, aprobaciones, triage de drift, el kill switch, push a SIEM).
- Referencia — la API REST (renderizada desde el propio contrato OpenAPI 3.1 del producto), la política de estabilidad de la API, el bus de eventos (un contrato AsyncAPI 3.0), el catálogo de módulos, la CLI y la configuración.
- Explicación — la arquitectura, el modelo de seguridad y el threat model, el licenciamiento open-core.
Convenciones
Sección titulada «Convenciones»- La búsqueda es local y del lado del cliente (Pagefind). Corre enteramente en tu navegador; nada se envía a un servicio de búsqueda externo — coherente con el diseño self-hosted del producto, en el que tú decides qué cruza tu perímetro.
- Versionada. La documentación está versionada: cuando se distribuye una nueva versión del producto, los docs de la anterior se preservan. El selector de versión vive en la barra superior.
- Honesta sobre los límites. Allí donde una capacidad está en fase de diseño, es posterior a v1, o simplemente no está construida todavía, los docs lo dicen llanamente. Consulta Honestidad y límites. Los comandos de tutoriales y how-to están pensados para ejecutarse tal como están escritos.
- Idiomas. La documentación canónica está en inglés; hay traducciones disponibles en español, chino simplificado, ruso, japonés, alemán y francés (traducción automática, con el inglés como versión autorizada, volviendo al inglés en las páginas aún no traducidas).