Document Plugins

[tiagoboldt]

I believe that a better plugin description, maybe on the top of each plugin, would make oh my zsh way easier to configure and adopt by the new zsh user.

[dougireton]

@tiagoboldt: I assume you have seen this: https://github.com/robbyrussell/oh-my-zsh/wiki/Plugins

[tiagoboldt]

@dougireton yup. Improving it and/or porting into the files themselves would really value the project :)

[robbyrussell]

I'd prefer that people update the wiki so that people can browse through a nice list there. A summary for each plugin is sufficient there... if they want to put more documentation (with tutorials) that'd be nice and/or include info in the plugin file itself. I feel like the wiki should have as much documentation as people are willing to contribute.

[tiagoboldt]

@robbyrussel +1 on that. Every plugin should be documented on the wiki at least. Maybe a documentation template could be provided on that page, something like:

• Name:
• Description:
• Usage:

[ColinHebert]

It could also work with readme.md in plugin directories.

This way you don't have to go on github to have your documentation, but it's still available from there.

[robbyrussell]

Closing this per #2568.