Leer el contenido de un artículo en la app
Abre un artículo autenticado de Docs en Antylogic y lee su guía sin cambiar datos del restaurante. La pantalla carga el artículo seleccionado desde el contenido empaquetado de Docs y muestra el título, el resumen, la visión general, los prerrequisitos, los pasos numerados, las comprobaciones, el resultado esperado, los artículos relacionados y el panel de contenidos de pantalla ancha cuando está disponible.
En este artículo
Usa esta guía cuando un responsable, operador o usuario de soporte necesite leer las guías de Antylogic dentro de la app con sesión iniciada.
Para la sesión demo de ES, el ejemplo estable es el artículo en español en antylogic://docs/accesos/es-access-users-create-location-internal. Abre documentación de solo lectura para Marea Gran Via y no crea ni actualiza registros de negocio.
Antes de empezar
- Has iniciado sesión en la app de Antylogic.
- La pantalla de Documentación está disponible desde el menú autenticado de la app o desde un enlace profundo antylogic://docs/....
- El índice de Docs se ha cargado y contiene el artículo que quieres leer.
- Para la sesión demo de ES, usa antylogic://docs/accesos/es-access-users-create-location-internal.
- Usa una ventana de al menos 1180px de ancho solo cuando necesites mostrar el panel Contenidos del lado derecho.
Instrucciones
- 1.
Abre Documentación
Abre Documentación desde el menú autenticado de la app, o abre un enlace directo de docs como antylogic://docs/accesos/es-access-users-create-location-internal. La ruta de la app requiere autenticación, pero no requiere una organización ni una ubicación seleccionadas.
- 2.
Espera a que el artículo se resuelva
Antylogic compara la sección y el artículo solicitados con el índice de Docs cargado. Si no se indica ningún artículo, abre el primero disponible; si se usa un enlace antiguo con articleId, la app lo sustituye por los slugs actuales de sección y artículo.
- 3.
Confirma la identidad del artículo
Usa la ruta de migas, el título, el resumen y la sección Visión general para confirmar que estás leyendo el artículo previsto. En la demo de ES, es-ES se envía a la API de Docs como es, así que se esperan etiquetas en español y contenido de artículo empaquetado en español.
- 4.
Lee las secciones de la guía
Revisa Antes de empezar cuando esté presente y después sigue los Pasos numerados. Usa Comprobaciones para confirmar las condiciones esperadas y Resultado esperado para entender el desenlace descrito por el artículo.
- 5.
Usa la navegación de apoyo
En pantallas anchas, usa Contenidos como lista rápida de las secciones que existen en el artículo cargado. Usa Artículos relacionados para seguir leyendo guías de la misma sección de Docs.
Validaciones y límites
- La ruta de artículo de la app usa /api/app/docs, no /api/public/docs.
- La petición de artículo se habilita solo cuando se conocen sectionSlug y articleSlug.
- Mientras la petición de detalle se carga, la columna del artículo muestra Cargando artículo.... Si falla, muestra No se pudo cargar la documentación.
- Si el artículo solicitado no está en el índice cargado, no se hace petición de detalle y la pantalla pide al usuario que seleccione un artículo.
- Los campos vacíos de prerrequisitos, pasos, comprobaciones, media o resultado esperado se ocultan en lugar de renderizar secciones en blanco.
- Los pasos se muestran en el orden del artículo y numerados desde 1.
- El panel Contenidos aparece solo con anchos de al menos 1180px y es solo informativo.
- Los artículos relacionados proceden de la misma sección, excluyen el artículo actual y se limitan a cuatro.
Resultado esperado
El usuario puede leer el artículo autenticado de Docs en la app, revisar su guía y pasar a documentación relacionada sin cambiar Grupo Marea Demo, Marea Gran Via ni ningún dato operativo.