Quelle devrait être la page d'accueil pour les catégories de documentation ?

Lorsque vous cliquez sur Documentation > Site Management, je me demande si cela ne devrait pas vous amener à l’index au lieu des derniers sujets.

Ou peut-être devrait-il vous amener à un autre sujet « d’aperçu » que vous spécifiez ?

Nous avions l’habitude de créer des liens vers l’index directement dans les descriptions de catégories pour le rendre plus facile à découvrir :

discussion connexe

Ou peut-être que c’est bien comme ça ? C’est peut-être redondant étant donné que l’index est déjà dans la barre latérale, mais quelque chose me semble un peu étrange dans la conception actuelle de deux façons :

  • l’index lui-même peut être difficile à trouver
  • la liste des derniers sujets semble un peu désorientante par rapport à la façon dont la navigation dans la documentation fonctionne une fois que vous êtes dans un sujet donné
4 « J'aime »

Je me demande si l’index offre une meilleure entrée dans la documentation. Le problème que je vois est que ni la page d’index ni la barre latérale ne permettent de parcourir et de naviguer facilement dans les sujets de la documentation :

Je ne suis pas sûr s’il existe une solution évidente ? Il existe des modèles pour de meilleures mises en page de barres latérales dans les plateformes de documentation existantes. Mais celles-ci amélioreraient-elles notre situation sans nécessiter plus de travail sur l’organisation réelle des sujets ? Elles pourraient ne pas bien fonctionner pour le wiki communautaire en général.

Peut-être qu’une barre latérale droite avec une disposition plus proche d’une table des matières, plutôt que l’actuelle barre latérale gauche étroite, fonctionnerait-elle mieux ?

3 « J'aime »

J’y ai aussi réfléchi, indépendamment de meta.discourse.org, mais comme un besoin général pour le plugin des catégories de documentation. Atteindre la page d’index est bien meilleur dans de nombreux cas et, je pense, clarifierait le contenu de la barre latérale pour les utilisateurs par rapport à l’arrivée directe dans une catégorie, où ils risqueraient de ne pas remarquer la modification de la barre latérale avant d’ouvrir un sujet.

Une option dans le plugin pour l’activer au niveau d’une catégorie serait idéale, afin que dans des cas avec des listes extrêmement longues comme mentionné ici, vous puissiez la désactiver, tandis que dans d’autres cas, vous pourriez l’activer.

J’ai creusé un peu plus ce sujet aujourd’hui. J’envisageais de faire une demande de tirage (pull request) pour ajouter un paramètre au plugin. Une fois activé, ce paramètre forcerait les liens directs vers une catégorie à rediriger le navigateur vers l’index de documentation de cette catégorie. En examinant les travaux existants sur le plugin, j’ai découvert une refonte beaucoup plus importante des fonctionnalités actuellement en cours : FEATURE: Add visual doc category index editor by megothss · Pull Request #87 · discourse/discourse-doc-categories · GitHub

Il me semble que ce serait le moment idéal pour ajouter ce type de fonctionnalité optionnelle permettant d’utiliser l’index de documentation comme liste des catégories. Dans le même temps, cela pourrait entrer en conflit avec un « Mode Simple » que @sam est en train de développer dans le cadre de la mise à jour. Sam, penses-tu que l’option que j’ai décrite ci-dessus pourrait s’intégrer à ton travail sur le Mode Simple ou à la refonte plus large dans la PR afin de proposer plus d’options pour construire l’index ? Ce serait vraiment formidable de pouvoir choisir la configuration simplifiée des colonnes que tu es en train de développer, ou simplement d’utiliser le sujet de l’index. Idéalement, le contenu du post s’afficherait au-dessus de la liste complète, normale ou simplifiée de la catégorie.

1 « J'aime »