Mejor navegación de documentación con una nueva barra lateral

Esta semana, publicamos una mejora significativa en la documentación de Discourse: ¡una nueva barra lateral! Esta función está diseñada para hacer que la navegación y el acceso a nuestra documentación sean más fáciles e intuitivos que nunca.

:star2: ¿Qué hay de nuevo?

La nueva barra lateral aparece en todas las categorías y temas de documentación, lo que facilita la navegación por su contenido. Esto es lo que puede esperar:

  1. Navegación mejorada: Con una estructura jerárquica clara, moverse entre diferentes temas es ahora más rápido y sencillo.

  2. Conciencia contextual: La barra lateral resalta los temas que está viendo actualmente, lo que facilita la comprensión de dónde se encuentra en la documentación.

  3. Secciones colapsables: Cada sección dentro de la barra lateral se puede colapsar y expandir según sea necesario, lo que facilita la búsqueda de los temas que necesita.

  4. Filtro en vivo: Encuentre rápidamente temas específicos en la barra lateral escribiendo palabras clave relevantes; si no se encuentra nada, se le invitará a realizar una búsqueda más profunda con la misma consulta.

  5. Amigable para dispositivos móviles: La nueva barra lateral funciona sin problemas en dispositivos móviles, con las mismas funciones que la vista de escritorio.

:eyes: Echemos un vistazo

:boom: ¡Puede ver la nueva barra lateral de documentación en acción hoy mismo!

Aquí hay algunas capturas de pantalla para darle una mejor idea de lo que puede esperar:

Como puede ver, la barra lateral proporciona una visión general clara de todas las secciones de documentación, lo que facilita la navegación.

Cada categoría muestra los temas dentro de ella, divididos en secciones definidas.

El tema que está viendo actualmente está resaltado en la barra lateral para facilitar la consulta.

Cada sección se puede colapsar, lo que le permite encontrar el contenido que necesita con más facilidad.

Las secciones individuales se pueden expandir para mostrar su contenido con más claridad.

:building_construction: Basado en mejoras recientes

Esta nueva barra lateral es parte de nuestros esfuerzos continuos para mejorar la experiencia de documentación de Discourse. Se basa en el trabajo reciente para reestructurar la documentación para una mayor claridad. La nueva barra lateral complementa estas mejoras estructurales al proporcionar una interfaz intuitiva para navegar por la documentación recategorizada.

Esto se combina con la revisión continua del contenido de todos nuestros temas de documentación para alinearlos con la guía de estilo publicada recientemente. Esto es un trabajo en progreso, y es posible que note mejoras graduales a medida que avanzamos.

:ear: ¡Queremos sus comentarios!

¿Ha tenido la oportunidad de usar la nueva barra lateral de documentación? ¡Nos encantaría conocer su opinión! Por favor, publique sus experiencias, sugerencias o cualquier pregunta que pueda tener sobre este tema.

Si tiene preguntas o comentarios sobre nuestros esfuerzos generales de documentación, háganoslo saber en este tema.

Gracias por ser parte de la comunidad de Discourse. Estamos emocionados de ver cómo esta nueva función mejora su experiencia con Discourse.

22 Me gusta

Felicidades por los nuevos cambios; son geniales. :clap:

  • Filtro en vivo en todas las categorías
    Sé que la forma en que funciona actualmente puede ser difícil; me hubiera gustado poder filtrar independientemente de qué (sub)categorías esté. Eso es lo primero que intenté:

Por supuesto, hay enlaces de ayuda, eso es genial. En cambio, habría esperado:

  • El contenido se desplaza hacia arriba al usar Ctrl + /
    Al usar el atajo para enfocar el campo de búsqueda, se desplaza tanto la barra lateral como el contenido. No espero que el contenido se desplace hacia arriba aquí.

  • Pérdida de la conciencia del contexto
    Si usas el filtro, haces clic en un tema y luego borras el filtro, es posible que no veas el tema resaltado. EDITAR: También, si navegas a un tema desde una publicación.

  • La sección colapsada no se resalta al ver un tema
    Si estás viendo un tema y colapsando las secciones, creo que sería útil desde el punto de vista del contexto resaltar la sección de alguna manera o simplemente enfatizarla.

9 Me gusta

¡Buena adición/mejora! :tada:

Es mucho más fácil navegar ya que es mucho más obvio dónde buscar :wink:

Una pequeña cosa es el orden de las categorías frente al orden en la barra lateral de navegación.

En Documentation, las últimas 3 categorías son:

Documentation > Migrating to Discourse
Documentation > Contributing
Documentation > Developer Guides

Sin embargo, en la barra lateral de navegación, Documentation > Developer Guides y Documentation > Contributing están cambiados.

¡Gran trabajo!

4 Me gusta

¿Deberían estar en orden coincidente?

¿Dónde estás viendo el orden alternativo?

1 me gusta

Estoy en el móvil.

Qué extraño. No sé por qué el tuyo es un poco diferente. :thinking:

Esto es lo que veo:

Tampoco parece que tengas una descripción de categoría de guía para desarrolladores en la caja. ¿Has silenciado la categoría o algo así?

3 Me gusta

¿Puedo habilitar una barra lateral de categorías como esta en otras instancias?

2 Me gusta

Es un Theme component GitHub - discourse/discourse-docs-sidebar.

5 Me gusta

¡Ah, eso era! ¡Problema resuelto! :wink:

5 Me gusta

Eres bienvenido a experimentar, pero hay mucho más por hacer para que esto sea algo que estemos preparados para respaldar completamente.

Hay una cantidad considerable de trabajo involucrado en el mantenimiento de los temas índice, que es lo que impulsa la interfaz de usuario de la barra lateral, y no hay un sistema incorporado para garantizar que permanezcan consistentes con los temas de la categoría.

Estamos aceptando ese trabajo adicional por ahora para mantener la documentación aquí, con el objetivo de recopilar comentarios de las personas sobre la experiencia de leer y navegar por la documentación aquí. Estamos buscando ese tipo de comentarios en este momento, más que comentarios sobre cómo es mantener la documentación utilizando este componente.

8 Me gusta

Esto es muy bueno, de hecho. Esperando una versión completa.

2 Me gusta

Es mucho más fácil de usar que el anterior. Más… claro. Pero puedo apostar que los más orientados técnicamente pueden verlo limitado.

No uso la documentación, incluso cuando la necesito, porque mis usuarios temen los filtros. Este sistema sería más fácil de usar.

Pero si necesita amor y cuidado constantes por parte del administrador… :thinking:

3 Me gusta

¡Gracias por señalar esto, @Arkshine! Todos estos deberían ser corregibles, así que veremos qué podemos hacer aquí.

2 Me gusta

De alguna manera, la barra lateral de la documentación cambia el funcionamiento de la búsqueda. En mi tablet, no puedo usar la tecla Enter para obtener los resultados de la búsqueda cuando la barra lateral de la documentación está visible. Noté que dice ‘next’ en lugar de ‘go’, pero no sé por qué.

No puedo reproducir el problema.

Lo intenté en mi iPad.

¿Puedes comprobar si sigue ocurriendo?

Todavía está sucediendo. Puedo reproducirlo en Chrome y Edge, pero no usando la aplicación Firefox.

Aún no puedo reproducirlo. No veo cómo la barra lateral de la documentación podría estar causando esto.

No altera ningún código de búsqueda.

Puede ser otra cosa.

¿Puedes proporcionar más detalles sobre la configuración que estás utilizando? Versión del navegador, sistema operativo, etc.

Galaxy Tab S9 FE
Android 14; SM-X510 Build/UP1A.231005.007
Chrome 126.0.6478.123

Intenté usar el teclado externo. Esto me ayudó a determinar que la tecla Enter aparentemente tiene que presionarse una segunda vez.

2 Me gusta

Ok, puedo reproducirlo en Android.

No es solo la barra lateral de la documentación, lo mismo ocurre con la barra lateral de administración.

Tendremos que investigar el problema.

Ya sé lo que está pasando.

Discutiremos la mejor solución internamente.

4 Me gusta

El problema debería resolverse en:

Ya está activo en Meta.

5 Me gusta