[wp-meta] [Making WordPress.org] #156: Allow ReadMe to support in-document links for h4s

[Making WordPress.org]

#156: Allow ReadMe to support in-document links for h4s
--------------------------+------------------------------
  Reporter:  MattyRob     |      Owner:
      Type:  enhancement  |     Status:  closed
  Priority:  normal       |  Component:  Plugin Directory
Resolution:  maybelater   |   Keywords:
--------------------------+------------------------------

Comment (by MattyRob):

 Replying to [comment:5 Otto42]:
 > Therefore, I would recommend NOT using the readme.txt for extensive
 documentation to begin with. Large changelogs should be moved out into
 separate files. FAQ sections should be limited to question for users
 *prior* to them installing your plugin.

 I agree completely with the principles of this but there are a couple
 things that have been missed:

 1. The current [https://wordpress.org/plugins/about/readme.txt Readme
 example] contains an FAQ header example - if it should not be in there
 then remove or amend that example.
 2. The WordPress plugin repository is a fabulous place to put code for
 others to use and all for free - as that is the case a good number of
 plugin authors do not have the time or money to launch a website of their
 own to host FAQs - so where exactly then are FAQs (and likely other
 things) supposed to be hosted? It's all well and good saying where they
 should not go - but where then should they be? They really should be with
 the plugin file.

 I'm not disagreeing with the sentiment that it needs to be done different
 or better but the WordPress plugin community deserves something a little
 better - the front end of the repository has not changed in almost 10
 years - perhaps it should be revised as in need of a little polish.

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