Leer el contenido de un artículo público
Abre un artículo público de Docs de Antylogic y lee la guía renderizada, incluidos el título, la visión general, los prerrequisitos, las instrucciones ordenadas, las comprobaciones, el estado de la media, el resultado esperado, las guías relacionadas y la navegación por secciones. La página es pública y no requiere una sesión autenticada de Antylogic.
En este artículo
Usa esta guía cuando un visitante público, un operador de restaurante o un compañero de soporte necesite leer un artículo de Docs de Antylogic desde el manual de la landing sin iniciar sesión.
La página del artículo se alimenta del índice de Docs generado y del contenido de detalle del artículo. Resuelve la ruta, carga el cuerpo del artículo y muestra solo las secciones que existen en el bundle generado.
Antes de empezar
- La ruta pública de Docs está disponible mediante `/docs`, `/manual` o `/wiki`.
- El artículo existe en el bundle de Docs generado para el locale de Docs seleccionado.
- Para capturas de ES en español, abre el artículo con `lang=es` para que la página pública de Docs resuelva el contenido en español.
- El servicio público de Docs del backend está configurado con el bundle de contenido de docs generado y con cualquier raíz de assets pública necesaria para la media.
Instrucciones
- 1.
Abre la URL pública del artículo
Abre una URL canónica de artículo como `/docs/accesos/es-access-users-create-location-internal?lang=es`. Si el visitante entra por `/manual` o `/wiki`, o abre una ruta de artículo antigua, la página resuelve el artículo desde el índice de Docs y navega a la ruta canónica `/docs/{sectionSlug}/{articleSlug}`.
- 2.
Confirma la cabecera y la navegación del artículo
Usa la cabecera para confirmar que se ha cargado el artículo esperado. La página muestra la ruta de migas de Docs, el nombre de la sección, el selector de dispositivo, el título del artículo, el resumen y el aviso de comentarios. La navegación izquierda expande la sección seleccionada y el carril derecho lista las secciones del artículo disponibles en la página.
- 3.
Lee la visión general y los prerrequisitos
Empieza por los párrafos de visión general y los prerrequisitos cuando estén presentes. La visión general procede del `intro` del artículo, y los prerrequisitos se muestran solo cuando el artículo generado los incluye.
- 4.
Sigue las instrucciones ordenadas
Lee cada instrucción numerada en orden. Cada paso usa el título y la descripción devueltos, y la lista de contenidos del lado derecho puede saltar directamente a anclajes estables basados en el slug del artículo y el número de paso.
- 5.
Revisa las comprobaciones y el resultado esperado
Usa las comprobaciones de validación y el resultado esperado para confirmar qué debería cumplirse tras seguir el artículo. Estas secciones son condicionales, así que un artículo puede mostrar comprobaciones, un resultado esperado, ambos o ninguno.
- 6.
Usa la media y las guías relacionadas
Revisa la media principal cerca de la parte superior del artículo y cualquier captura adicional más abajo en la página. Si el bundle generado contiene media planificada sin fuente pública, la página muestra el marcador de pendiente de generación. Las guías relacionadas proceden de la misma sección cargada y excluyen el artículo actual.
Validaciones y límites
- No se requiere inicio de sesión, pertenencia a organización, pertenencia a ubicación ni permiso de producto.
- El flujo del artículo público es de solo lectura y no crea reportes, no autentica visitantes ni cambia datos de Antylogic.
- El frontend carga el índice de Docs antes del detalle del artículo porque la resolución de la ruta depende de los valores de `DocsArticleSummary`.
- La petición de detalle del artículo usa `locale`, `platform` y `theme`; la consulta de búsqueda `q` no forma parte de esta acción.
- La ruta de migas muestra `Docs` y el título de sección devuelto; no añade el título del artículo como segmento de la ruta de migas.
- Las secciones de prerrequisitos, pasos, validaciones, media, resultado y guías relacionadas se omiten cuando el artículo no tiene contenido fuente para ellas.
- Cuando un elemento de media no tiene fuente resuelta, la página muestra el marcador de pendiente de generación en lugar de inventar una imagen o un vídeo.
- Las guías relacionadas se seleccionan de la misma sección cargada, excluyen el artículo actual y se limitan a tres elementos.
- La página de la landing solo solicita los locales de Docs generados `en` y `es`; otros idiomas de la interfaz de la landing caen al contenido de Docs en inglés en `WikiScreen`.
- Las comprobaciones `HEAD` en las rutas públicas de Docs confirman solo la disponibilidad del servicio y no deben describirse como búsqueda de contenido de artículo.
Resultado esperado
El visitante puede leer el artículo público, seguir sus instrucciones y comprobaciones, entender cualquier estado de media o de media pendiente, y continuar a guías relacionadas sin iniciar sesión ni cambiar datos de Antylogic.