[wp-meta] [Making WordPress.org] #3454: Add new plugin/theme readme header tag for documentation link

[Making WordPress.org]

#3454: Add new plugin/theme readme header tag for documentation link
------------------------------+------------------------------------
 Reporter:  danieliser        |       Owner:
     Type:  enhancement       |      Status:  new
 Priority:  normal            |   Milestone:  Plugin Directory v3.0
Component:  Plugin Directory  |  Resolution:
 Keywords:                    |
------------------------------+------------------------------------

Comment (by danieliser):

 I don’t disagree that it should be enough, but in my experience it isn’t.

 My plugin Popup maker does in fact link to docs from description and faq
 tabs. Will have to check installation. That said we even have inline
 documentation links for many settings as well.

 Still get users nearly every week saying there was no documentation which
 is bananas. We have probably 100+ pages of docs.

 If it was a standard feature in the readme and gained adoption, and of
 course was displayed where only plugin meta can be.

 Further places it could be placed:

 - A checkbox on the support ticket form agreeing they have searched the
 docs with a link to them (if they exist)
 - Links in the sidebar of the support forums for each plugin could include
 links to docs
 - Enhanced plugin search could promote those with docs
 - Searh results could potentially list that the plugin at least has
 documentation with an icon for instance.

 Most of those would be unavoidable for the user, especially if they were
 trying to get help.

 That said none of them can be accomplished if there is no standardized way
 of feeding that data.

--
Ticket URL: <https://meta.trac.wordpress.org/ticket/3454#comment:2>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org