Mise à jour de la documentation

Bonjour,

Comme certains le savent, nous travaillons depuis plusieurs mois sur une refonte de la documentation. Une première pièce est arrivée hier avec le passage sur la nouvelle interface des docs pour le core de jeedom (uniquement à partir du site de doc, en direct, ce sera à partir de vos Jeedom avec la prochaine version du core), et les tutos + premiers pas + compatibilité….. tout sauf les plugins.

Pour la partie technique (pour ceux que ça intéresse), on passe maintenant en github page avec jekyll et un thème maison, ce qui nous oblige à convertir toutes les docs de asciidoc à markdown et à passer la branche principale sur github à master. Donc une fois la migration finie on aura 2 branches : beta et master.

Hormis l’interface, le gros avantage de ce changement c’est qu’on ne gère plus la génération de la doc qui commençait à prendre trop de temps (plus de 24h) et n’était donc plus possible.

Maintenant nous allons petit à petit migrer les plugins vers ce nouveau système puis refaire aussi la page de présentation du site de doc pour que vous puissiez plus facilement retrouver une information dedans.

Autre bonne nouvelle de ce changement, il devrait résoudre les soucis de 404 lorsque vous voulez aller sur une doc depuis votre Jeedom (pour rappel la même chose depuis le site de doc marche). Nous profitons aussi de ce changement pour normaliser les changelogs et donc essayer de vous en proposer plus souvent (pour rappel si rien dans le changelog c’est soit une correction d’orthographe, le robot de traduction, l’ajout ou le retrait d’un espace… enfin rien d’important)

Pour les développeurs tierces nous allons mettre à jour le plugin template pour que vous voyez comment faire.

Cet article a été lu 3674 fois

Vous aimerez aussi...