Documentation - Githubissues

babastienne commented 4 months ago

Liste des choses à modifier dans le documentation :

[ ] :red_circle: Compléter les sections manquantes
[x] :orange_circle: Modifier les exemples de code pour les simplifier ? Ne plus mettre <grw-app CONFIGURATION></grw-app> mais directement <grw-app CONFIGURATION/> ?
[x] :green_circle: Réduire le poids des images qui sont un peu lourdes
[x] :orange_circle: Sur les captures d'écran essayer d'avoir des contenus complets (par exemple ici il manque des pictos pour les évènements sur la carte, c'est moche)
[x] :orange_circle: Ajouter un favicon geotrek sur la doc
[x] :question: Est-il possible d'intégrer directement un exemple de widget dynamique dans la doc plutôt que des captures ?
[x] :red_circle: Faire une passe sur les textes pour corriger quelques fautes / relecture générale (@babastienne )
[ ] :orange_circle: :question: L'ensemble des captures d'écran en exemple sont avec un design "carré". Or par défaut le widget est arrondi et pas carré, donc on met en avant sur les captures comme si c'était par défaut un design qui en réalité est un paramètre. Est-ce souhaitable ?
[x] :question: Est-ce qu'on ne renomme pas la section "Thème" en "Paramétrages" ?
[x] :orange_circle: Modifier le readme pour mettre le lien vers la documentation

babastienne commented 4 months ago

https://github.com/GeotrekCE/Geotrek-rando-widget/pull/80#issuecomment-1945718965

bastyen commented 4 months ago

Modifier les exemples de code pour les simplifier ? Ne plus mettre mais directement ?

Ne pas faire ça, toujours utiliser <grw-xxxx></grw-xxxx>

bastyen commented 4 months ago

Est-ce qu'on ne renomme pas la section "Thème" en "Paramétrages" ?

Je ne suis pas pour car cette section concerne que le style.

bruhnild commented 4 months ago

Que pensez vous de l'idée d'avoir un favicon geotrek d'une couleur différente pour les documentations geotrek-admin, geotrek-widget (et plus tard geotrek-rando) pour pouvoir les distinguer dans le navigateur ?

babastienne commented 4 months ago

Je ne suis pas convaincu. Pour les différencier il y a le titre de l'onglet qui est déjà pas mal. Et puis je pense qu'avoir plusieurs documentation Geotrek différentes d'ouvertes sur son navigateur c'est surtout une problématique de devs / contributeurs plus que d'utilisateurs.

bastyen commented 1 month ago

Peux-tu faire une passe sur cette issue @bruhnild ?

GeotrekCE / Geotrek-rando-widget

Documentation #81