search

GeotrekCE / Geotrek-rando-widget

Web components to display Geotrek content on any website
https://geotrek-rando-widget.readthedocs.io
MIT License
6 stars 1 forks source link

[Documentation] Starting documentation #80

Closed bruhnild closed 7 months ago

bruhnild commented 7 months ago

https://github.com/GeotrekCE/Geotrek-rando-widget/issues/81

camillemonchicourt commented 7 months ago

J'arrive un peu tard, mais je me méfie de la duplication de documentation. Je pense notamment aux rubriques "about/geotrek/projects.md" et "/about/geotrek/what-is-geotrek.md" qui sont aussi présentes dans la doc de Geotrek-admin. A chaque fois qu'on duplique de la documentation, elle diverge très vite, car on la fait évoluer d'un côté mais pas de l'autre. Donc je n'aurai pas remis ces pages de doc, mais plutôt fait un lien pour renvoyer vers celle de Geotrek-admin pour qu'on maintienne ça qu'à un endroit (ce qui n'est déjà pas anodin 😀).

Je me concentrerai ici uniquement sur les infos liées uniquement à Geotrek-rando-widget.

babastienne commented 7 months ago

Oui en effet bonne idée de mettre un lien pour ne pas avoir à maintenir deux fois les mêmes docs.

bruhnild commented 7 months ago

Oui je suis plutot d'accord aussi, un lien renvoyant vers les infos de la documentation geotrek-admin suffira dans les sections "Qu'est ce que Geotrek ?" , "Les projets".

A faire quand cette PR aura été mergé