Make WordPress Core

Opened 12 years ago

Closed 11 years ago

Last modified 11 years ago

#20318 closed enhancement (duplicate)

Introduce a Usage section to the Plugins API

Reported by: johnbillion's profile johnbillion Owned by:
Milestone: Priority: normal
Severity: normal Version:
Component: WordPress.org Site Keywords:
Focuses: Cc:

Description

I quite often find a need for a 'Usage' section in my plugin's readme file. I usually place this within the 'Installation' section (example), but I've seen other plugins that include full usage instructions in the main description, in the FAQs, or in the 'Other Notes' section.

It would be nice if there was a top level readme section for Usage which showed up as a tab on the WordPress.org Plugin Directory.

Change History (7)

#1 @scribu
12 years ago

I think renaming "Installation" to "Usage" would be enough, since most of the times you can skip the installation steps altogether.

#2 @dd32
12 years ago

I think renaming "Installation" to "Usage" would be enough

I like that, considering that most Plugins should not have any "installation" steps anymore, the ones that do (caching plugins for example) would still be able to list any custom installation procedures required in a Usage tab.

#3 @jane
12 years ago

  • Type changed from feature request to enhancement

I think Instructions or Directions would be a better label. When I first saw this ticket I thought Usage referred to how/how many people were using the plugin.

#4 follow-up: @scribu
12 years ago

"Instructions" sounds fine to me.

It would take it's content from either the == Instructions == section in readme.txt or from == Installation == to preserve back-compat for all the existing plugins.

#5 in reply to: ↑ 4 @johnbillion
12 years ago

Replying to scribu:

"Instructions" sounds fine to me.

It would take it's content from either the == Instructions == section in readme.txt or from == Installation == to preserve back-compat for all the existing plugins.

That all sounds good. +1 from me.

#6 @samuelsidler
11 years ago

  • Milestone WordPress.org deleted
  • Status changed from new to closed

Migrated to #meta123.

#7 @SergeyBiryukov
11 years ago

  • Resolution set to duplicate
Note: See TracTickets for help on using tickets.