Docs públicas

Empieza con la CLI y luego lee el mismo contexto en el espacio web.

La documentación de LogBrew mantiene configuración, lecturas de telemetría, estado del panel y espejos Markdown legibles para agentes en una ruta pública predecible.

Abrir panelLeer Markdown
Primer comando
logbrew status --json

Status es local, seguro para tokens y devuelve pasos de recuperación que los agentes pueden interpretar antes de leer datos del proyecto.

Mapa de comandos

Status

Comprueba auth local, alcance de la API y pasos de recuperación antes de cualquier lectura privada.

logbrew status --json

Mapa de comandos

Logs

Empieza por errores recientes cuando una versión, proyecto o traza necesite contexto.

logbrew logs --level error --json

Mapa de comandos

Incidencias

Lista grupos abiertos antes de decidir si resolver, cerrar, ignorar o reabrir.

logbrew issues open --json

Mapa de comandos

Detalle de traza

Lee una traza conocida cuando logs o incidencias apunten a una petición fallida.

logbrew trace <trace_id> --json

Mapa de comandos

Acciones

Filtra eventos de usuario por nombre cuando el contexto importante sea una acción de producto.

logbrew actions --name checkout_failed --json

Mapa de comandos

Versiones

Compara contexto de despliegue con recuentos de logs, incidencias, spans de traza y acciones.

logbrew releases --json

CLI primero

Comprueba la autenticación local y el alcance de la API

La primera lectura debe indicar a personas y agentes si la CLI puede llegar a la API de LogBrew sin exponer material de token.

  • Usa modo JSON cuando un agente necesite campos estables.
  • Usa salida humana cuando una persona necesite el siguiente comando.
  • Mantén la recuperación de auth apuntando a login y status.

Observar

Lee señales de producción por recurso

Logs, incidencias, acciones, trazas, versiones y proyectos deben estar separados para escanear rápido y conectados para recuperar contexto.

  • Los logs conservan filtros de nivel, versión, entorno, proyecto, traza y búsqueda.
  • Las incidencias conservan estado, contexto de traza y vocabulario de mutación.
  • Las trazas conservan nombres de span, contexto de versión, contexto de entorno y alcance de proyecto.

Agentes

Mantén las docs públicas legibles sin estado de navegador

Cada página pública debe tener un espejo Markdown y seguir accesible sin JavaScript, cookies, inicio de sesión, CAPTCHA ni páginas de desafío.

  • Usa llms.txt para listar recursos públicos para agentes.
  • Usa robots.txt para permitir lectura pública y proteger rutas privadas.
  • Mantén los datos del panel detrás de auth del backend y metadatos noindex.

Mapa de API

Alinea el panel con las rutas del backend

El espacio web debe leer los grupos de rutas existentes de la API Rust, sin inventar almacenamiento exclusivo del panel ni contratos alternativos.

  • Los logs se leen desde /api/logs con filtros de nivel, versión, entorno, proyecto, traza y búsqueda.
  • Las incidencias se leen y mutan por /api/telemetry/issues y /api/telemetry/issues/{issue_id}.
  • Acciones, versiones y detalle de traza se leen por /api/telemetry/actions, /api/telemetry/releases y /api/telemetry/traces/{trace_id}.
  • Proyectos y estado de auth vienen de /api/projects, /api/auth y comandos CLI de status.