Abrir un artículo relacionado en Docs
Desde un artículo autenticado de Docs en la app, un operador puede abrir un artículo relacionado de la misma sección desde el bloque Artículos relacionados. El artículo cambia dentro de la misma pantalla de Documentación y no cambia organizaciones, ubicaciones, roles, tickets ni contenido de docs.
En este artículo
Usa esta guía cuando un operador autenticado ya esté leyendo un artículo de Docs en la app y quiera continuar con otro artículo de la misma sección sin salir de Docs.
Los artículos relacionados se toman del índice de Docs ya cargado para el idioma, la plataforma y el tema actuales. La lista no son resultados de búsqueda, ranking, recomendaciones, analítica, paginación ni un flujo de actualización de contenido.
Antes de empezar
- El operador ha iniciado sesión para que la superficie autenticada /api/app/docs pueda cargarse.
- La pantalla de Documentación ha cargado el índice de Docs para el locale, el tamaño de dispositivo y el tema actuales. Para la demo de ES, es-ES resuelve al contenido de Docs en español.
- Hay un artículo seleccionado, por ejemplo antylogic://docs/accesos-y-permisos/es-crear-rol-de-organizacion.
- La sección del artículo seleccionado contiene al menos otro artículo; en caso contrario el bloque Artículos relacionados se oculta.
Instrucciones
- 1.
Abre el artículo de origen
Abre Docs en el artículo de origen, por ejemplo antylogic://docs/accesos-y-permisos/es-crear-rol-de-organizacion. La pantalla resuelve el artículo desde el índice cargado y obtiene el detalle de artículo coincidente desde /api/app/docs/accesos-y-permisos/es-crear-rol-de-organizacion.
- 2.
Revisa Artículos relacionados
Desplázate hasta la parte inferior del artículo. Cuando la sección actual de Accesos tiene compañeros, Docs muestra hasta cuatro títulos de la misma sección, excluyendo el artículo actual.
- 3.
Abre un artículo relacionado
Selecciona un título relacionado como Crear un usuario interno de ubicación. Docs actualiza la ruta de Documentación con los sectionSlug y articleSlug relacionados y después carga el artículo relacionado en la misma pantalla.
- 4.
Gestiona el contenido no disponible
Si el índice o el detalle del artículo se están cargando, están vacíos o han fallado, se muestra el estado normal de carga, vacío o error y no se renderizan los artículos relacionados. Si la búsqueda del detalle falla después de seleccionar un título relacionado, la ruta ya ha cambiado y la columna del artículo muestra el estado genérico de error de Docs.
Validaciones y límites
- La lista de relacionados solo se calcula cuando existe un resumen de artículo seleccionado.
- Los títulos relacionados se restringen al section_slug del resumen seleccionado.
- El artículo actual se excluye de su propia lista de relacionados.
- Solo se muestran los cuatro primeros artículos restantes de la sección.
- La petición de detalle de artículo se ejecuta solo cuando están presentes sectionSlug y articleSlug.
- El texto de búsqueda de la barra lateral no filtra el bloque Artículos relacionados.
- La acción es de solo lectura y no tiene puerta de permisos de organización, ubicación ni rol específico de docs tras la autenticación.
Resultado esperado
El operador permanece en la pantalla de Documentación con el artículo relacionado cargado. Los parámetros de navegación apuntan ahora al artículo relacionado y no ha cambiado ningún dato operativo de Grupo Marea Demo ni de Marea Gran Via.