Abrir Docs en la app
Abre la pantalla autenticada de Documentación de la app desde el menú de cuenta o la ruta `/docs`. La pantalla es de solo lectura, no requiere una organización o ubicación seleccionada y carga el índice de documentación antes de seleccionar el primer artículo disponible.
En este artículo
Usa esta guía cuando un operador, un responsable de ubicación o un miembro del equipo de soporte necesite abrir las guías de Antylogic desde dentro de la app autenticada. En la demo de ES, el recorrido empieza desde el usuario demo en Marea Gran Via.
Abrir Docs solo carga guías. No crea tickets de soporte, no cambia datos del restaurante ni ejecuta una búsqueda en el servidor cuando se abre la pantalla.
Antes de empezar
- La app está en línea, actualizada y ha terminado de cargar.
- El usuario ha iniciado sesión en la app.
- Si se usa el recorrido por el menú, el menú de cuenta está disponible y no está bloqueado por un cierre de sesión, una limpieza de demo, una eliminación de token push u otra acción de cuenta.
Instrucciones
- 1.
Abre el espacio de trabajo autenticado
Parte de la app con sesión iniciada, por ejemplo Marea Gran Via en la demo de ES. Asegúrate de que ninguna pantalla de inicio de sesión, sin conexión, actualización obligatoria o recuperación de cuenta está bloqueando la navegación de la app.
- 2.
Abre el menú de cuenta
Abre el menú de cuenta del usuario de la sesión actual. En la demo de ES es el menú de cuenta del usuario demo.
- 3.
Elige Docs
Selecciona `Docs`. Si la app ya está en la pantalla de Documentación, el menú simplemente se cierra. En caso contrario, Antylogic abre la ruta `Documentación`.
- 4.
Espera a que se cargue el índice
La pantalla solicita el índice de docs con el locale, la plataforma y el tema resueltos. Cuando `/docs` se abre sin parámetros de artículo, el primer artículo disponible se selecciona después de que el índice responda.
- 5.
Usa la ruta directa cuando haga falta
Abre `/docs` o `antylogic://docs` para llegar a la misma pantalla sin usar el menú. Usa `antylogic://docs/:sectionSlug/:articleSlug` solo cuando enlaces a un artículo conocido; la coincidencia del artículo ocurre después de que el índice se haya cargado.
Validaciones y límites
- `Documentación` se abre dentro de la pila autenticada de la app, así que los usuarios no autenticados no pueden llegar a esta pantalla directamente.
- Esta ruta no requiere ningún permiso granular de docs, ni organización o ubicación seleccionadas.
- Usa `/docs` o `antylogic://docs`; no documentes esto como una ruta contextual `/{orgId}/{locationId}/docs`.
- La pantalla es de solo lectura y no muta datos de producto ni crea tickets de soporte.
- La caja de búsqueda nativa filtra localmente después de cargar el índice; esta acción no debe describirse como si enviase una búsqueda `q` al servidor.
- Los slugs de artículo inválidos o los valores heredados de `articleId` sin coincidencia dejan sin artículo seleccionado hasta que el índice cargado pueda resolver una coincidencia.
Resultado esperado
El usuario llega a la pantalla de Documentación de solo lectura. Cuando hay contenido disponible, la pantalla muestra Docs, el campo de búsqueda, la lista de secciones y el primer artículo seleccionado.