Buscar dentro de Docs
Encuentra artículos desde la pantalla Docs usando el campo `Buscar en Docs`. La búsqueda filtra en cliente el índice de documentación ya cargado para la sesión, idioma, dispositivo y tema actuales; no crea, edita ni elimina datos de Grupo Marea Demo ni convierte el texto visible en una query compartible.
En este artículo
Usa esta guía cuando una persona de sala, operaciones o administración necesita localizar una ayuda dentro de Antylogic sin salir de la pantalla Docs.
El buscador visible trabaja sobre las secciones ya cargadas por `GET /api/app/docs`. Aunque la API también acepta `q`, `DocumentationPage` no lo usa para el campo visible: carga el índice con `locale`, `platform` y `theme`, y después filtra localmente.
Antes de empezar
- Tener una sesión activa en la app de Antylogic.
- Abrir Docs desde el menú de usuario o mediante `antylogic://docs`.
- Esperar a que la pantalla termine de cargar el índice antes de escribir en el buscador.
- Disponer de artículos de Docs para el idioma y dispositivo actuales.
Instrucciones
- 1.
Abrir Docs
Entra en Docs desde el menú de usuario o abre `antylogic://docs`. Si llegas con un enlace a un artículo, como `antylogic://docs/:sectionSlug/:articleSlug`, la barra lateral conserva el buscador.
- 2.
Buscar un término
Escribe una palabra en `Buscar en Docs`. Para una captura en español, usa `reservas`, porque existe en el contenido de Docs y muestra resultados reales sin preparar datos operativos adicionales.
- 3.
Revisar la lista filtrada
La barra lateral conserva solo secciones con artículos coincidentes. Mientras el campo tiene texto, las secciones resultantes se muestran abiertas para facilitar la elección del artículo.
- 4.
Abrir un artículo
Selecciona un artículo de la lista filtrada para ver su detalle. Si ya había un artículo abierto antes de buscar, puede seguir visible hasta elegir otro resultado.
- 5.
Limpiar o probar sin resultados
Borra el campo para recuperar todos los artículos del índice cargado. Para documentar el estado vacío, escribe un término inexistente como `zzzz`.
Validaciones y límites
- La acción es de solo lectura y no modifica entidades del restaurante.
- El input visible filtra `docsIndexQuery.data.sections` ya cargado y no dispara una petición nueva por cada cambio.
- `DocumentationPage` no pasa `q` desde el buscador visible; el contador junto al buscador sigue mostrando el total del índice cargado.
- La coincidencia local usa `title`, `summary`, `section_slug`, `action_id` y `primary_keyword`.
- La búsqueda recorta espacios, compara en minúsculas y funciona por substring; no hay ranking, búsqueda difusa ni normalización de acentos.
- Una búsqueda vacía o con solo espacios restaura todos los artículos visibles.
- Si no hay coincidencias, la pantalla muestra `No hay artículos que coincidan con esta búsqueda.`
- El texto buscado no queda reflejado en URL, route params ni query key, así que no es un estado enlazable.
Resultado esperado
La persona usuaria localiza y abre un artículo de Docs desde el índice ya cargado, sin crear ni modificar datos. Al limpiar el campo, la lista vuelve a mostrar todos los artículos disponibles para la sesión, idioma, dispositivo y tema actuales.