essai d'une nouvelle structure de la documentation FR #1049
Conversation
plutôt que d'avoir toute la documentation à la racine du site, la proposition suivante consiste à découper la navigation à partir de 4 sections : - les fonctionnalités - les guides d'utilisation - les tutoriels - la faq Pour l'instant cette preuve de concept n'est que pour la partie fr de la documentation, il faudra la dupliquer sur la partie en anglais dès qu'elle sera validée
✅ Deploy Preview for stylo-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
…ctions faq, tutoriels, fonctionnalites, guides_utilisation
Cette partie ne devrait pas être dans la documentation de Stylo, on peut utiliser soit le site de R30 pour ça, soit faire un blog pour Stylo, soit utiliser la fonctionnalité discussion pour épingler des nouveautés et informer les utilisateurs
|
D'autres propositions :
|
|
voir #1048 |
|
Pour remplacer les items de menu (plutôt que de combiner avec le parent), il faut voir cette partie de la documentation 11ty: La discussion correspondante dans le développement d'11ty: |
… dataDeepMerge sur les données des menus de navigation
Ca fonctionne bien, je remets les liens vers les versions en/fr dans chaque menu du coup |
…ctionnalites, faq, guides_utilisation et tutoriels
…le fichier fonctionnalites/index.md
…dataDeepMerge(true) + reordonner le menu à gauche + certaines pages sont maintenant dans le footer
docs/.eleventy.js
Outdated
| @@ -50,6 +50,9 @@ module.exports = function(eleventyConfig) { | |||
| ], | |||
| }); | |||
|
|
|||
| // Empêche le comportement par défaut d'eleventy de faire un merge sur les données d'un tableau | |||
There was a problem hiding this comment.
Pas juste d'un tableau (Array) mais de n'importe quelle propriété héritée de la structure de données.
There was a problem hiding this comment.
Un lien vers la documentation pourrait être ajouté dans le commentaire
| <div | ||
| class="document-footer__rights" | ||
| @html="$data.contact" | ||
| ></div> | ||
| <div | ||
| class="document-footer__rights" | ||
| @html="$data.sources" | ||
| ></div> | ||
| <div | ||
| class="document-footer__rights" | ||
| @html="$data.colophon" | ||
| ></div> |
There was a problem hiding this comment.
- La classe
footer__rightsne devrait probablement pas être répétée: elle sert à indiquer la nature du contenu. - est-ce que
contact,sources,colophondoivent vraiment être ajoutés ici? - il faudrait au moins documenter dans l'en-tête du composant quelles variables globales sont utilisées, si cet ajout est retenu.
| @@ -1,5 +1,6 @@ | |||
| --- | |||
| title: Structurer la bibliographie | |||
| title: "Structurer la bibliographie" | |||
| date: Last modified | |||
There was a problem hiding this comment.
Est-ce qu la propriété Date: Last modified est nécessaire ici? Est-ce que ce n'est pas déjà le cas pour toutes les pages? Si c'est le cas, mieux vaut éviter d'ajouter du code inutile.
There was a problem hiding this comment.
Par souci de cohérence (s'il y en a une): est-ce que les mots des slugs ne devraient pas être séparés par des traits d'union - au lieu d'une barre en bas _? Dans la documentation, certains slugs sont sans espaces (ex. mesarticles) et d'autres comportent un trait d'union (ex. syntaxe-bibtex).
There was a problem hiding this comment.
Oui je suis pour modifier cette partie. C'est dans la todo pour quand on s'occupera des contenus, ils vont bientôt être modifié du fait de la restructuration et on en profitera pour tout renommer proprement selon une seule syntaxe. Pour l'instant les contenus ont juste été ajoutés au fil des ans et sans réellement de protocole, créant ainsi une incohérence dans le nommage des fichiers
RochDLY
changed the title
|
Que pensez-vous de l'ajout d'un bouton (plus facilement identifiable que "Stylo" en haut à gauche) pour revenir à la page d'accueil de la documentation? |
|
Pour répondre à tous les commentaires, je vois qu'on a des retours sur l'UX et sur la partie graphique. Voici une proposition pour ne pas bloquer les changements de la documentation :
Est-ce que ça semble vous semble correct ? @loup-brun @cgermain97 Personnellement :
|
|
Oups désolée pour l'accrochage de boutons... Je suis d'accord avec ce que tu dis Roch. Je retirerais le contact de la FAQ et au pire on peut en faire une question posée. Sinon le reste me semble beau, comme on en a discuté hier. |
…changement du comportement des hyperliens et changement des noms des classes pour correspondre aux contenus. Ajout des variables globales utilisées dans le ocmposant page-footer.webc. Correction des métadonnées dans bibliographie.md. Corrections des informations dans le colophon.md. Déplacement de la page contact.md à la racine (et modifications des hyperliens)
RochDLY
changed the title
✅ Deploy Preview for stylo-dev ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
RochDLY
had a problem deploying
to
github-pages
GitHub Actions
Failure
plutôt que d'avoir toute la documentation à la racine du site, la proposition suivante consiste à découper la navigation à partir de 4 sections :
Pour l'instant cette preuve de concept n'est que pour la partie fr de la documentation, il faudra la dupliquer sur la partie en anglais dès qu'elle sera validée