[wp-meta] [Making WordPress.org] #3454: Add new plugin/theme readme header tag for documentation link
Making WordPress.org
noreply at wordpress.org
Thu Feb 15 04:02:45 UTC 2018
#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: close |
------------------------------+------------------------------------
Comment (by danieliser):
@obenland So if we have docs we have to choose between that link and one
to our sales/general info site, if so I'm gonna choose to send users where
they can learn about the product as a whole (features, upgrades, blog etc)
as any other plugin developer who monetizes would.
I mean you can decide this isn't worth working on, but I think
documentation is a hugely important part of the WP ecosystem, enough to
warrant its own spot/url when available & relevant. We have entire teams
dedicated to docs for core and the other WP systems already which proves
that it matches the communities direction and has potential to reduce
support loads in general.
Most plugins of substance (those that actually require substantial docs)
are more and more moving documentation to its own portal such as
HelpScout.
Just took a quick look for reference at the current guidelines for plugin
readme & headers, this is the only definition of what plugin uri should
be.
Author and Plugin Homepages
The Author URI and Plugin URI fields of the plugin header. The Plugin URI
should be unique to
each plugin.
- https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-
txt-works/
And again
Plugin URI: The home page of the plugin, which should be a unique URL,
preferably on your own
website. This must be unique to your plugin. You cannot use a
WordPress.org URL here.
- https://developer.wordpress.org/plugins/the-basics/header-requirements/
Clearly they don't intend you to put doc link there.
--
Ticket URL: <https://meta.trac.wordpress.org/ticket/3454#comment:7>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org
More information about the wp-meta
mailing list