Seleccionar artículo
La pantalla de Documentación decide qué artículo abrir a partir de una ruta directa, de un articleId legado o del primer artículo disponible del índice. Es una consulta de solo lectura: carga el índice y el detalle autenticados desde Docs sin modificar datos operativos.
En este artículo
Usa esta guía para entender cómo Docs abre el artículo correcto cuando un usuario entra desde el menú, desde un enlace directo o desde otro enlace interno de documentación.
La selección se resuelve siempre contra el índice cargado: primero sección y slug de artículo, después articleId legado normalizado y, solo si no hay selección explícita, el primer artículo disponible.
Antes de empezar
- El usuario debe tener una sesión iniciada para consultar los endpoints de Docs de la app.
- El contenido de documentación debe estar disponible en el entorno de ejecución.
- La pantalla debe abrirse desde Menú de usuario > Docs, desde antylogic://docs o desde una ruta directa con sectionSlug y articleSlug.
- Para capturas, usar la demo española Grupo Marea Demo con la sesión Demo Marea y la ubicación Marea Gran Via.
Instrucciones
- 1.
Abrir Docs
Entra en Docs desde el menú de usuario o abre un enlace directo. Si la ruta incluye sección y artículo, como antylogic://docs/acceso/es-iniciar-sesion-nativa, la pantalla intenta resolver exactamente ese artículo. Si se abre solo antylogic://docs, carga el índice y selecciona el primer artículo disponible.
- 2.
Cargar el índice
La pantalla solicita GET /api/app/docs con locale, platform y theme. En la demo española el idioma se resuelve como es. Mientras carga puede aparecer Cargando documentación; cuando llega el índice, la app agrupa los artículos por sección y prepara el listado lateral.
- 3.
Confirmar la selección
Comprueba que el artículo esperado queda marcado y que la sección correspondiente está abierta. Si la selección viene de articleId, la app lo normaliza y después deja la ruta con sectionSlug y articleSlug.
- 4.
Revisar el detalle
Cuando hay un resumen válido, la app solicita GET /api/app/docs/{sectionSlug}/{articleSlug} con los mismos parámetros del índice y renderiza título, resumen, requisitos, pasos, comprobaciones, resultado, capturas si existen y artículos relacionados.
- 5.
Cambiar de artículo
Selecciona otro artículo desde el listado lateral o desde relacionados. La pantalla navega de nuevo a Documentation con la sección y el slug del artículo elegido, marca ese enlace y carga su detalle.
Validaciones y límites
- La prioridad real es sectionSlug + articleSlug, después articleId legado, después primer artículo del índice.
- Una ruta completa inválida no cae automáticamente al primer artículo; muestra el estado para seleccionar un artículo.
- La búsqueda visible en la pantalla filtra localmente el índice ya recibido; no envía q al backend en este flujo.
- No documentar que platform o theme filtran artículos del índice; en el comportamiento verificado afectan a parámetros, metadatos y media.
- No inventar permisos funcionales de Docs: el acceso encontrado depende de sesión autenticada.
- La acción es solo lectura y no modifica reservas, TPV, catálogos, empleados ni datos de Grupo Marea Demo.
Resultado esperado
Docs queda abierto con el artículo seleccionado, la ruta canonicalizada cuando corresponde y el detalle cargado desde el contenido autenticado de documentación.