[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:  wontfix      |   Keywords:
--------------------------+------------------------------
Changes (by Otto42):

 * status:  new => closed
 * resolution:   => wontfix


Comment:

 The current implementation of the readme.txt files does not support readme
 files much larger than about 10k to begin with, and even that causes major
 problems since the content of the readme.txt is sent as part of the API
 response.

 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.

 Documentation on using the plugin should be contained within the plugin
 itself, possibly using the Help tabs built into WordPress or some other
 kind of explanatory screens in the admin. The readme.txt is not really the
 end-all be all of documentation.

 As such, wontfix for now. Even in the future, when the readme.txt size
 limitation is removed, it will still be sent along in the API response,
 and so an arbitrary size limitation will likely be implemented. Probably
 about 8k or less.

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