Shipping documentation with a plugin

There’s no standard conventions around shipping documentation with plugins, and it would be nice if there was. One idea: include a /docs/ folder with text files in markdown. Those documents would automatically show up in your wporg plugin profile.

2 Comments

Jonathan Desrosiers November 5, 2012 Reply

Reblogged this on Jonathan Desrosiers and commented:
Testing reblogging to my .org WordPress site.

mbijon November 14, 2012 Reply

+1

Seems simple enough and idea (except maybe the Markdown part) and it could really help improve the experience from the current one-page Installation info.

Leave a Reply