Abrir pantalla Docs
Abre la superficie Docs autenticada desde el menú de usuario o desde un enlace directo. La app carga el índice con idioma, plataforma y tema calculados en cliente, sin exigir ubicación activa ni permisos de soporte.
En este artículo
Usa esta guía cuando un operador de Grupo Marea Demo necesite consultar la documentación interna desde la app mientras trabaja en una sesión autenticada.
Docs es una superficie global de ayuda. Puede abrirse desde el menú de usuario o con `antylogic://docs`, y no depende de tener seleccionada Marea Gran Via ni otra ubicación activa.
Antes de empezar
- Tener una sesión autenticada o una sesión demo activa, por ejemplo Demo Marea en Grupo Marea Demo.
- Tener disponible el backend de Docs con `articles.json` configurado para `/api/app/docs`.
- Usar la app con sus contextos normales de idioma, tema y tamaño de pantalla, porque de ahí salen `locale`, `theme` y `platform`.
- No hace falta seleccionar una ubicación: Docs queda fuera del contexto operativo de local.
Instrucciones
- 1.
Entrar con sesión válida
Abre la app con un usuario autenticado o con la sesión demo ES. Si no hay sesión, la app muestra Login y no monta la superficie principal donde vive Docs.
- 2.
Abrir Docs desde el menú de usuario
Abre el menú de cuenta de usuario y pulsa `Docs`. Esta es la entrada recomendada para operadores que ya están trabajando dentro de la aplicación.
- 3.
Usar un enlace directo cuando proceda
También puedes abrir `antylogic://docs`. Si el enlace incluye sección y artículo, como `antylogic://docs/acceso/es-iniciar-sesion-nativa`, la misma pantalla intenta resolver ese artículo al cargar.
- 4.
Esperar la carga del índice
Al entrar, la pantalla calcula `locale`, `platform` y `theme`, y solicita el índice autenticado a `GET /api/app/docs` con esos parámetros.
- 5.
Revisar la pantalla Docs
Cuando el índice responde, comprueba que se ven el título `Docs`, el buscador local, el contador de artículos, las secciones y la píldora de plataforma calculada por la app.
- 6.
Reconocer aperturas con artículo inicial
Si el enlace trae parámetros de artículo o la pantalla selecciona el primer artículo disponible, puede cargarse el detalle como efecto de la apertura. La lectura completa pertenece al flujo `documentation.app.select-article`.
Validaciones y límites
- La pantalla solo se monta con sesión autenticada; `/api/app/docs` está protegido por `requireAuth`.
- No documentar `user-reports:manage` como requisito: ese permiso aplica a la bandeja de soporte, no a abrir Docs.
- `locale` usa `en` si el idioma empieza por inglés; en cualquier otro caso usa `es`.
- `platform` se calcula por ancho de pantalla: `<768` es `mobile`, `<1180` es `tablet` y el resto es `web`.
- La apertura normal no envía `q`; el buscador visible filtra localmente el índice ya cargado.
- No mezclar esta guía con `/api/public/docs`; aquí se documenta la superficie autenticada de app.
- Si falta `articles.json` o el servicio de Docs no está configurado, la pantalla muestra el estado de error de carga.
Resultado esperado
El usuario llega a Docs con el índice autenticado cargado para su idioma, plataforma y tema. La acción es de solo lectura: no crea datos de negocio, tickets de soporte ni cambios de configuración.