Meilleure navigation dans la documentation avec une nouvelle barre latérale

Cette semaine, nous avons publié une amélioration significative de la documentation Discourse - une nouvelle barre latérale ! Cette fonctionnalité est conçue pour rendre la navigation et l’accès à notre documentation plus faciles et plus intuitifs que jamais.

:star2: Quoi de neuf ?

La nouvelle barre latérale s’affiche sur toutes les catégories et tous les sujets de documentation, facilitant la navigation dans leur contenu. Voici ce à quoi vous pouvez vous attendre :

  1. Navigation améliorée : Avec une structure hiérarchique claire, le passage d’un sujet à l’autre est désormais plus rapide et plus simple.
  2. Conscience du contexte : La barre latérale met en évidence les sujets que vous consultez actuellement, ce qui vous permet de comprendre facilement où vous vous trouvez dans la documentation.
  3. Sections repliables : Chaque section de la barre latérale peut être repliée et dépliée selon les besoins, ce qui facilite la recherche des sujets dont vous avez besoin.
  4. Filtre en direct : Trouvez rapidement des sujets spécifiques dans la barre latérale en tapant des mots-clés pertinents - si rien n’est trouvé, vous serez invité à effectuer une recherche plus approfondie avec la même requête.
  5. Adapté aux mobiles : La nouvelle barre latérale fonctionne de manière transparente sur mobile, avec les mêmes fonctionnalités que la vue de bureau.

:eyes: Jetons un coup d’œil

:boom: Vous pouvez voir la nouvelle barre latérale de documentation en action dès aujourd’hui !

Voici quelques captures d’écran pour vous donner une meilleure idée de ce à quoi vous attendre :

Comme vous pouvez le voir, la barre latérale offre un aperçu clair de toutes les sections de documentation, ce qui rend la navigation un jeu d’enfant.

Chaque catégorie affiche les sujets qu’elle contient, divisés en sections définies.

Le sujet que vous consultez actuellement est mis en surbrillance dans la barre latérale pour une référence facile.

Chaque section peut être repliée, vous permettant de trouver plus facilement le contenu dont vous avez besoin.

Les sections individuelles peuvent être dépliées pour afficher leur contenu plus clairement.

:building_construction: S’appuyer sur les améliorations récentes

Cette nouvelle barre latérale fait partie de nos efforts continus pour améliorer l’expérience de documentation de Discourse. Elle s’appuie sur les travaux récents visant à restructurer la documentation pour une meilleure clarté. La nouvelle barre latérale complète ces améliorations structurelles en fournissant une interface intuitive pour naviguer dans la documentation recatégorisée.

Ceci est associé à la refonte en cours du contenu de tous nos sujets de documentation pour s’aligner sur le guide de style récemment publié. C’est un travail en cours, et vous remarquerez peut-être des améliorations progressives au fur et à mesure.

:ear: Nous voulons vos commentaires !

Avez-vous eu l’occasion d’utiliser la nouvelle barre latérale de documentation ? Nous aimerions connaître votre avis ! Veuillez poster vos expériences, suggestions ou toute question que vous pourriez avoir sur ce sujet.

Si vous avez des questions ou des commentaires sur nos efforts globaux en matière de documentation, veuillez nous en faire part sur ce sujet.

Merci de faire partie de la communauté Discourse. Nous sommes impatients de voir comment cette nouvelle fonctionnalité améliorera votre expérience Discourse.

22 « J'aime »

Félicitations pour les nouveaux changements ; ils sont vraiment super. :clap:

  • Filtre en direct dans toutes les catégories
    Je sais que la façon dont cela fonctionne actuellement peut être difficile ; j’aurais aimé pouvoir filtrer indépendamment des (sous-)catégories dans lesquelles je me trouve. C’est la première chose que j’ai naturellement essayée :

Bien sûr, il y a des liens pour aider, c’est super. Au lieu de cela, je m’attendais à :

  • Le contenu défile vers le haut lors de l’utilisation de Ctrl + /
    Lorsque vous utilisez le raccourci pour focaliser le champ de recherche, il fait défiler la barre latérale et le contenu vers le haut. Je ne m’attendais pas à ce que le contenu défile vers le haut ici.

  • Perte de la conscience du contexte
    Si vous utilisez le filtre, cliquez sur un sujet, puis effacez le filtre, vous risquez de ne pas voir le sujet mis en surbrillance. EDIT : De plus, si vous naviguez vers un sujet à partir d’un message.

  • La section réduite n’est pas mise en surbrillance lors de la visualisation d’un sujet
    Si vous visualisez un sujet et que vous réduisez les sections, je pense qu’il serait utile pour le contexte de mettre en surbrillance la section d’une manière ou d’une autre ou simplement de l’accentuer.

9 « J'aime »

Bon ajout/amélioration ! :tada:

C’est tellement plus simple de naviguer car il est beaucoup plus évident où chercher :wink:

Une petite chose concerne l’ordre des catégories par rapport à l’ordre dans la barre latérale de navigation.

Dans Documentation, les 3 dernières catégories sont :

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

Cependant, sur la barre latérale de navigation, Documentation > Developer Guides et Documentation > Contributing sont inversés.

Excellent travail !

4 « J'aime »

Ils devraient être dans le même ordre ?

Où voyez-vous l’ordre différent ?

1 « J'aime »

Je suis sur mobile.

Étrange. Je ne sais pas pourquoi le vôtre est un peu différent. :thinking:

Voici ce que je vois :

Vous ne semblez pas non plus avoir de description de catégorie de guide développeur dans la boîte. Avez-vous mis la catégorie en sourdine ou quelque chose comme ça ?

3 « J'aime »

Puis-je activer une barre latérale de catégorie comme celle-ci sur d’autres instances ?

2 « J'aime »

C’est un Theme component GitHub - discourse/discourse-docs-sidebar.

5 « J'aime »

Ahh c’était ça, problème résolu ! :wink:

5 « J'aime »

Vous êtes invité à expérimenter, mais il y a beaucoup plus à faire pour que cela devienne quelque chose que nous sommes prêts à prendre entièrement en charge.

Il y a une quantité considérable de travail pour maintenir les sujets d’index, qui sont ce qui pilote l’interface utilisateur de la barre latérale, et aucun système intégré pour s’assurer qu’ils restent cohérents avec les sujets de la catégorie.

Nous acceptons cette charge de travail pour maintenir la documentation ici pour le moment, en nous concentrant sur la collecte des commentaires des utilisateurs sur l’expérience de lecture et de navigation dans la documentation ici. Nous recherchons ce type de commentaires pour le moment plutôt que des commentaires sur la façon de maintenir la documentation en utilisant ce composant.

8 « J'aime »

C’est très bien en effet. Au plaisir de découvrir la version complète.

2 « J'aime »

Il est beaucoup plus facile à utiliser que l’ancien. Plus… clair. Mais je peux parier que ceux qui sont plus orientés techniquement pourraient le trouver limitant.

Je n’utilise pas la documentation, même quand j’en ai besoin, car mes utilisateurs ont peur des filtres. Ce système serait plus convivial.

Mais s’il a besoin d’amour et de soins constants de la part de l’administrateur… :thinking:

3 « J'aime »

Merci d’avoir signalé ces points, @Arkshine ! Ils devraient tous être corrigeables, nous verrons donc ce que nous pouvons faire ici.

2 « J'aime »

D’une manière ou d’une autre, la barre latérale de la documentation modifie le fonctionnement de la recherche. Sur ma tablette, je ne peux pas utiliser la touche Entrée pour obtenir les résultats de recherche lorsque la barre latérale de la documentation est visible. J’ai remarqué qu’il est écrit « next » au lieu de « go », mais je ne sais pas pourquoi.

Je n’arrive pas à reproduire le problème.

Je viens d’essayer sur mon iPad.

Pouvez-vous vérifier si cela se produit toujours ?

Ça se produit toujours. Je peux le reproduire dans Chrome et Edge, mais pas en utilisant l’application Firefox.

Pourtant, je n’arrive pas à reproduire le problème. Je ne vois pas comment la barre latérale de la documentation pourrait causer cela.

Elle ne modifie aucun code de recherche.

C’est peut-être autre chose.

Pouvez-vous fournir plus de détails sur la configuration que vous utilisez ? Version du navigateur, système d’exploitation, etc.

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

J’ai essayé le clavier externe. Cela m’a aidé à déterminer que la touche Entrée doit apparemment être enfoncée une deuxième fois.

2 « J'aime »

Ok, je peux reproduire sur Android.

Ce n’est pas seulement la barre latérale de la documentation, la même chose se produit avec la barre latérale d’administration également.

Nous devrons enquêter sur le problème.

Je sais déjà ce qui se passe.

Nous discuterons de la meilleure solution en interne.

4 « J'aime »

Le problème devrait être résolu par :

C’est déjà en ligne sur Meta

5 « J'aime »