2

When I submit a plugin to the wordpress public repo, how am I supposed to submit documentation? What is considered standard or good practice? Should I just have all documentation on the be page that the plugin is mirrored on, or should I also include a readme of sorts? I know when submitting to CodeCanyon, it's standard to package documentation with the plugin, but it's not super important what file format you use as long as it can be viewed without paid software. I don't, however, know what the standard for submission to the public repo is. Insight anybody?

  • You can add it on plugin page. Or if it too large host it on your site. – Sisir Jan 3 '14 at 4:33
  • Is there any sort of good resource on how to structure your documentation? I just want to ensure there isn't a set of rules I should be following. – Thought Space Designs Jan 3 '14 at 4:54
  • I would wait for other comment to come in but Github Wiki is another good place for placing your documentation. – Sisir Jan 3 '14 at 5:03
  • Utilize the plugin Description, FAQ, 'Other Notes' sections to its full extent. else as already suggested by Sisir, its best to host the documentation on your site and provide link in readme.txt. If you want to improve documentation by community/users, then Github Wiki is best. – Subharanjan Jan 3 '14 at 7:25
1

This is my most popular plugin. Flowplayer HTML5 for WordPress

I did try to think through my documentation etc. All of the documentation should be in the readme.txt. It is the best place as that added to WordPress.org for easy access. You can use this link to validate your readme.

Not all plugins do need any documentation so it is not a must but can make it easier for users.

Another way of doing to it adding a link to your site in the readme where you have the documentation. Polylang does it this way.

You can update the readme.txt without needing to change the plugin version so it is no more difficult to update the documentation in the readme then it is on your site.

Here is also the the WordPress.org guidelines.

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.