review-val

.github/workflows/doc.yml

@@ -3,7 +3,7 @@ name: publish_doc
 on:
   push:
     branches:
-      - release
+      - hlecuyer/feat/generate-automatic-documentation
 
 permissions:
   contents: write

docs/index.md

@@ -1,4 +1,31 @@
-# Data inclusion documentation
+Cette documentation dépôt contient le schéma de l'offre d'insertion. Il est issu de la collaboration d'acteurs de l'insertion. Il comprend deux éléments principaux:
 
 - [Structure](structure.md)
-- [Service](service.md)
+- [Service](service.md)
+
+## Contexte
+
+La démarche a été initiée par l'équipe [Dora](https://beta.gouv.fr/startups/dora.html), portée le GIP Plateforme de l'inclusion.
+
+Il a été constaté l'existence d'une multitude de portails en ligne ou simulateurs, mais pas de langage commun pour décrire l’offre d’insertion et peu de partage des informations. La diffusion des aides et des dispositifs en est diminuée. Des informations sur les aides ou dispositifs deviennent obsolètes. Les efforts de saisie et de développement sont multipliés.
+
+Ce schéma a été créé avec la collaboration des acteurs de l'insertion afin d'harmoniser les données et de permettre l'intéropérabilité entre les différents acteurs et leurs outils.
+
+## Le schéma
+
+Le schéma définit les structures de l'insertion et devraient à terme inclure les services proposés par ces structures. Il comprend les informations essentielles permettant  de décrire l'offre d'insertion et la réutilisation par les acteurs de l'insertion.
+
+Le schéma est pour le moment formalisé dans le format JSON schema. Nous veillions néanmoins à maintenir la possibilité de représenter les données au format csv.
+
+
+## Consolidation
+
+data.inclusion réalise une consolidation et publie la base consolidée, aux formats json et csv, sur [data.gouv.fr](https://www.data.gouv.fr/en/datasets/referentiel-de-loffre-dinsertion-liste-des-structures-et-services-dinsertion/).
+
+## Aide à la saisie
+
+Les structures qui partagent leurs données via l'outil [Dora](https://dora.inclusion.beta.gouv.fr/) sont incluses par défaut dans la base consolidée.
+
+## Contribuer
+
+Vous pouvez créer un [nouveau ticket](https://github.com/gip-inclusion/data-inclusion-schema/issues/new) sur le dépôt ouvert du schéma pour proposer une modification ou une amélioration ou poser une question.

docs/referentiel.md.j2

@@ -1,10 +1,12 @@
 {% for referential_item in referential %}
 ### `{{ referential_item.value }}`
 
-Label: {{ referential_item.label }}
+**Label :** {{ referential_item.label }}
 
 {% if referential_item.description %}
-Description: {{ referential_item.description }}
+!!! abstract "Description"
+
+    {{ referential_item.description }}
 {% endif %}
 
 {% endfor %}