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.

Author: Daniel Bachhuber

Proud father x2. Principal, Hand Built. Maintainer, WP-CLI.

2 thoughts on “Shipping documentation with a plugin”

  1. +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

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s