Plugin Documentation Style Guide

[jomaxro (Joshua Rosenfeld)]

Part 7 of the Plugin guide is now up:

Developing Discourse Plugins - Part 7 - Publish your plugin

Previous tutorial: Developing Discourse Plugins - Part 6 - Add acceptance tests You’ve created your plugin, you’ve uploaded it to GitHub and you’ve added tests. Great! Problem is, no one else knows about it. Documenting your plugin All plugins require good documentation. Users need to know what the plugin does, how to install it, important settings/configuration changes needed, and how to use it. Plugins should be documented in two different locations: the README.md file within your git repo,…