WordPress.org

Making WordPress.org

Opened 5 months ago

Closed 3 months ago

#3354 closed enhancement (wontfix)

Create new plugin documentation section in directory

Reported by: danieltj Owned by:
Milestone: Priority: normal
Component: Plugin Directory Keywords: close
Cc:

Description

I'm not sure of the scale that this change would bring, although I'm sure it'd be huge. I'd like to see a documentation section for plugins on the directory pages. Something similar to the Developer Hub (developer.wordpress...) which auto populates functions and hooks for example automatically based on the plugin code.

This is mainly because I have a few plugins, with some that have custom hooks/filters that I think would be better off in a documentation section rather than lost in the plugin description area. That way any developers wanting to make use of them know where to look and can see the code fully.

Change History (2)

#1 @obenland
3 months ago

  • Keywords close added

I'm not sure the Plugin Directory is the best place for that. I'd encourage you to use the site your Plugin URL points to, to add documentation there. @Otto42 has probably more to say on the topic, but as far as I understand it the directory is not meant to be used that way

#2 @Otto42
3 months ago

  • Resolution set to wontfix
  • Status changed from new to closed

Kinda agree with @obenland on this. The plugin directory is a hosting system, not a full documentation hub. If you want to document things for users, put links in the plugin to the docs, or just add the relevant information inline. The readme is basically a sales pitch, of sorts, and not meant to be a complete documentation resource either. You have your own site, and the Plugin URI field should point to it.

Note: See TracTickets for help on using tickets.