Améliorations diverses des pages de doc des règles #354
Conversation
References could be deduced from the description fied for instance, not necessarily from the références attribute
To let the user override this with references from elsewhere if needed
laem
force-pushed
the
meilleures-pages-doc
branch
from
e1f259d
to
52bcd1b
Compare
There was a problem hiding this comment.
C'est chouette comme fonctionnalité ! Peut-être mettre à jour la doc également ? https://publi.codes/docs/api/react-ui
Désolé pour le délai de review, on a eu pas mal de truc à gérer côté ME.
| @@ -24,6 +24,7 @@ export type SupportedRenderers = { | |||
| */ | |||
| Text?: ComponentType<{ children: string }> | |||
| References?: typeof References | |||
| VisualisationBlock?: React.ComponentType | |||
There was a problem hiding this comment.
J'ajouterai un peu de tsdoc ici pour préciser à quoi sert VisualisationBlock. De ce que je comprends, il s'agit d'un composant custom à ajouter dans les pages règles entre la description et l'explication des calculs. Si c'est bien ça, je propose un tout petit ajout : passer en prop le dottedName de la règle courante, au cas où l'on souhaite avoir une logique d'affichage différente en fonction de la règle.
| > | ||
| {capitalise0(name)} | ||
| </a> | ||
| <span className="ui__ label">{link}</span> |
There was a problem hiding this comment.
Je crois que l'on peut supprimer les ui__ label qui ne sont plus utilisés.
| @@ -36,6 +36,14 @@ type RulePageProps = { | |||
| mobileMenuPortalId?: string | |||
| openNavButtonPortalId?: string | |||
| showDevSection?: boolean | |||
| contributionLink?: { | |||
| repository: string | |||
| // e.g. repository: 'datagir/nosgestesclimat', | |||
There was a problem hiding this comment.
Cela peut passer en tsdoc également pour en bénéficier directement dans l'IDE lorsqu'on autocomplete les props.
| @@ -147,9 +159,15 @@ function Rule({ | |||
| <Article> | |||
| <DottedNameContext.Provider value={dottedName}> | |||
| <RuleHeader dottedName={dottedName} /> | |||
| {question && ( | |||
There was a problem hiding this comment.
Ce n'est pas bizarre d'afficher la question à chaque fois juste au-dessus de la description ? Cela ne donne-t-il pas l'impression que la description est une réponse à la question ? (c'est une vraie interrogation, peut-être que pas du tout)
Ceci étant dit, sur le principe, je suis pour afficher la question dans la documentation.
There was a problem hiding this comment.
Je me suis posé un peu la même question, pour la page https://pages-doc-rapides--nosgestesclimat.netlify.app/documentation/alimentation/plats j'ai eu du mal à comprendre la relation entre la description et la question 🤔
There was a problem hiding this comment.
En effet, suite à une remarque de @Clemog j'ai ajouté un label "aide à la saisie" quand il s'agit d'une question.
Fixes #336
Fait principalement pour nosgestesclimat, mais ambition générique.
Dans le but de pouvoir afficher à google une version lisible de la page sans parsing ni calcul, donc beaucoup plus rapide.
CF incubateur-ademe/nosgestesclimat-site#778 pour comprendre avec une démo
À tester hors de ce dépôt dans un premier temps je pense, car RulePage et notamment son menu, sont trop intriqués avec
engine---> c'est le but notamment de incubateur-ademe/nosgestesclimat-site#778Que l'on utiliserait chez nosgestesclimat pour insérer des graphiques spéciaux pour certaines pages, exemple ici https://nosgestesclimat.fr/documentation/bilan
référencesindépendamment de la présence de références dans la règlePourquoi ? Car on peut vouloir ajouter en tant que consommateur de RulePage des références pour certaines règles particulières; on peut vouloir déduire des références des règles parentes.
Lien vaguement utile de studio pour tester