Comment soumettre une documentation avec plugin
Lorsque je soumets un plugin au dépôt public wordpress, comment dois-je soumettre de la documentation? Qu'est-ce qui est considéré comme standard ou comme bonne pratique? Devrais-je avoir uniquement toute la documentation sur la page d'accueil sur laquelle le plug-in est mis en miroir, ou devrais-je également inclure un fichier Readme? Je sais que lors de la soumission à CodeCanyon, il est courant de regrouper la documentation avec le plug-in, mais le format de fichier que vous utilisez est sans importance, tant qu'il est lisible sans logiciel payant. Cependant, je ne sais pas quelle est la norme de soumission au référentiel public. Insight quelqu'un?
Ceci est mon plugin le plus populaire. Flowplayer HTML5 pour WordPress
J'ai essayé de réfléchir à ma documentation, etc. Toute la documentation devrait être dans le fichier readme.txt. C'est le meilleur endroit que celui ajouté à WordPress.org pour un accès facile. Vous pouvez utiliser ce lien pour valider votre lisez-moi.
Tous les plugins n’ont pas besoin de documentation, ce n’est donc pas une obligation mais peut faciliter la tâche des utilisateurs.
Une autre façon d’y ajouter un lien vers votre site dans le fichier Lisez-moi où se trouve la documentation. Polylang le fait de cette façon.
Vous pouvez mettre à jour le fichier readme.txt sans avoir à changer la version du plug-in, il n'est donc pas plus difficile de mettre à jour la documentation dans le fichier readme que sur votre site.
Voici également les directives de WordPress.org .