Documentation - Ajout de doc par sources & notebooks #91
Description
Why
Pour la reprise du projet en aval, (ou pour ajouter du contexte à d'éventuels agents/LLM) il est nécessaire :
- D'expliciter les choix techniques adoptés par source. (utilisation d'une api où non et pourquoi, lien vers la doc de la source externe si disponible, expliciter les typologies, définitions des champs si nécessaire etc...)
- D'expliquer comment mettre à jour les jupyter notebook
How
- Définir un template de doc minimal par source (e.g. reprise des infos du tableau "sources de données"
- Créer une doc spécifique et/ou bien commenter les jupyter notebooks pour expliquer les opérations de "pré-traitement" réalisées
- Ajout de typologie, définition de nomenclatures en tant que sources et les documenter en lien avec les sources de données qui en ont besoin (e.g. BMO)
What
- (suggestion, à définir) création de dossiers et de fichiers readme: documentation/domain/source.md
- (suggestion, à définir) modification du datasources.yaml et du modèle associé pour ajouter une clé "documentation" qui pointe vers le bon readme.md