Antylogic
Probar demoAcceso app

399 guías operativas

Secciones de Docs
DocsDocumentación pública
Dispositivo

Abrir índice público de Docs

Abre la wiki pública de Antylogic desde `/docs` para consultar el índice de guías disponibles sin iniciar sesión, seleccionar organización ni cargar datos de demo.

En este artículo

Docs público es la entrada de ayuda de la landing. Sirve un índice de guías operativas para visitantes y usuarios que quieren consultar documentación antes de entrar en la app.

La pantalla resuelve idioma, dispositivo y tema, carga resúmenes desde la API pública y deja el detalle completo de cada guía para el flujo de artículo.

Antes de empezar

  • La landing pública de Antylogic está disponible en `/docs`, `/manual` o `/wiki`.
  • La API pública de documentación está accesible desde `PUBLIC_API_BASE_URL`; en local la landing usa `http://localhost:8081` como fallback.
  • Existe contenido publicado en `backend/docs-content/articles.json` para `es` o `en`.
  • No hace falta iniciar sesión, seleccionar organización, seleccionar ubicación ni preparar Grupo Marea Demo.

Instrucciones

  1. 1.

    Abrir Docs público

    Entra en `/docs?lang=es`. También se puede llegar desde `/manual` o `/wiki`, aunque los enlaces internos vuelven a la ruta canónica `/docs`.

  2. 2.

    Confirmar idioma y dispositivo

    La landing limita el idioma de Docs a `es` o `en`, detecta la plataforma inicial como móvil, tablet o web, y aplica el tema claro u oscuro activo.

  3. 3.

    Cargar el índice

    La pantalla pide `GET /api/public/docs` con `locale`, `platform` y `theme`. El índice agrupa artículos por sección y muestra resúmenes, no el cuerpo completo de cada guía.

  4. 4.

    Buscar una guía

    Usa el buscador visible para filtrar localmente el índice ya cargado. Esa búsqueda no envía `q` al backend en el flujo normal de la pantalla.

  5. 5.

    Entrar en un artículo

    Si la URL no apunta a una guía concreta y hay artículos, Docs selecciona el primer resumen y reemplaza la ruta por `/docs/{section_slug}/{slug}` para cargar el detalle.

  6. 6.

    Validar variantes públicas

    Para soporte o integraciones, consulta directamente `HEAD /api/public/docs` o `GET /api/public/docs?locale=es-ES&device=iphone&q=reservas`. Esos casos documentan el contrato API, no el buscador normal de la landing.

Validaciones y límites

  • `GET /api/public/docs` y `HEAD /api/public/docs` son públicos y no requieren permiso de usuario.
  • El endpoint público acepta solo `GET` y `HEAD`; otros métodos devuelven `405` con `metodo no permitido`.
  • Si falta el servicio o archivo de contenido, la API devuelve `503`; si el JSON no se puede leer o decodificar, devuelve `500`.
  • Los valores no reconocidos de idioma, plataforma o tema se normalizan a defaults; no se tratan como errores de validación estricta.
  • El índice devuelve resúmenes con `article_count`, `sections`, `icon_name` y `has_media`; pasos, validaciones y recursos se obtienen desde el detalle del artículo.
  • La pantalla muestra `No hemos podido cargar Docs.` cuando la respuesta pública no es `2xx` o falla la red.
  • Los assets se sirven desde el flujo de detalle y solo si el path queda dentro de `DOCS_ASSETS_PATH`.

Resultado esperado

El visitante ve el índice público de Docs con secciones, contador de guías, selector de dispositivo y navegación hacia el primer artículo, sin sesión ni contexto de organización.