There's a new Plugin Info plugin available from the Jomres Plugin Manager.

This plugin's job is to scan the installed plugin directories and search for any README.md files. If the file exists then it's contents will be displayed on this page, which will be available in Admin > Jomres > Dashboard > Plugin Information.

Jomres plugin information is found mainly in the Plugin Manager, or in the Manual.

This means that whenever a plugin is created or updated, I then have to find the time to log into the manual, make the relevant changes and hope that you users can find them. Unfortunately the space available in the plugin manager isn't big enough to provide detailed instructions on how to use any plugin, or add any notes so up until now I've been making those notes in the manual whenever I've remembered.

The truth is, this isn't the best way to do things. Plugins are often updated in tandem with other plugins to take advantage of new features, but it's easy to forget to update the manual while I'm mentually juggling all those apples so instead I'm going to switch over to a new way of delivering detailed information about plugins.

In the future, where I feel it's necessary, I'm going to add README.md markdown files to individual plugins. The new Plugin Info plugin will then be able to use any available README.md files to build information which I feel that you as integrators will want to know to use the plugin.

Eventually, I expect to remove the Plugins section in the manual altogether.

 

Documentation, Plugins