URL de la page de documentation intégrée dans le plugin

Bonjour,

Il est facile de pointer vers la documentation en ligne, par contre, je ne sais pas comment pointer vers la documentation intégrée dans le plugin qui est celle qui est à jour avec la version du plugin installée (normalement).
Quel est l’url à utiliser pour pointer vers la documentation intégrée ?

Merci pour vos lumières

A+
Michel

Salut,

Tu veux dire afficher le markdown de la doc locale directement dans Jeedom c’est bien ça ?

Ce n’est pas encore pris en charge dans le core mais c’est dans les points que je souhaite étudier à l’avenir pour voir la faisabilité.

1 « J'aime »

Oui, c’est exactement ça.

Je me disais bien que je ne trouvais rien dans ce sens et avais peur d’être passé à coté d’une info quand même assez importante. J’ai cherché un moment, mais j’ai finalement posé la question.

Je trouve d’ailleurs curieux que ce ne soit pas encore possible dans la mesure où la doc fait partie de la structure du plugin. Ca voudrait donc dire que cette partie-là du plugin est présente sur les machines où est installé le plugin mais absolument pas exploitée.

En tout cas je suis bien content que ce ne soit pas que dans ma vision que cette fonction manque et me réjouis de cette possibilité.
:+1:

Si l’utilisateur a une version inférieure à celle en ligne, il lira une documentation périmée et n’ira jamais relire la même doc en ligne pour comparer ce qu’il manque.
Je trouve pas l’idée fameuse.
Autant supprimer le lien de la doc en ligne dans l’info.json du plugin.

Si c’est appliqué, va falloir donner du travail aux développeurs qui ne mettent plus la doc dans le répertoire du plugin. Refonte de leur doc obligatoire en markdown ?

Plusieurs devs ne mettent pas la doc dans le plugin d’ailleurs, btw, ca diminue bien la taille du plugin surtout s’il y a des images dans la doc.

Puis c’est du markdown que l’on a et continuera d’écrire pour être transformé sur github.
Du coup on va devoir le faire interpréter en local. Il y a du défi (ca existe sûrement tout fait)

Peu d’utilisateurs n’ont aucun accès à internet donc la doc en ligne suffit je trouve, pas convaincu qu’il y ai un réel intérêt à passer du temps la dessus.

1 « J'aime »

Dans ma tête, l’idée serait de permettre aux devs qui le veulent d’afficher le markdown inclus dans le plugin. Bien évidemment, rien d’obligatoire (non mais oh !) mais la possibilité de le faire.
Libre à l’utilisateur de consulter cette doc offline et de la comparer avec la doc online pour savoir si des nouvelles fonctionnalités lui seraient utiles.

Rien de plus. Juste la possibilité de la faire.

Après si c’est pas fait bah on fera sans… on fait déjà sans beaucoup de choses.

Tu crois en toute sincérité que les utilisateurs vont comparer 2 documentations ?

Il faudrait déjà qu’ils regardent celle de disponible avant de poser des questions.

Pour quelqu’un qui garde un vielle version, vaut mieux, sinon c’est vrai qu’il peut tout simplement faire un backup, la mise à jour et revenir en arrière, poster ici une question demandant pourquoi ça marche pas sans aucune autre info… puis regarder la doc une fois que c’est ce qu’on lui aura répondu sur ce community
:wink:

Maintenant que je lis la réponse de @Mips ci-dessus ça me rappelle que c’était déjà la réponse que Loïc m’avait fait quand j’avais abordé ce sujet avec lui : trop complexe pour peu d’intérêt.

Du coup faudrait plutôt voir pour coder un plugin qui permettrait de consulter les documentations présentes localement je pense… Qui sera le 1er dev à proposer quelque chose ? :sweat_smile:

Ce sujet a été automatiquement fermé après 24 heures suivant le dernier commentaire. Aucune réponse n’est permise dorénavant.