Better WordPress Code Reference


Discussions have been ongoing about better code reference for WordPress. Here’s where we are so far:

  • @rmccue, @duck_, and @djpaul have been developing the parser, which isn’t far off
  • we need to have a discussion about how be are going to do user contributions. Are we going to use WP comments functionality? I thought it would be cool if we attach a taxonomy to the comments we could tag them as explanation or example and they could be spat out in the right place. This would require a Code Reference Moderator, so someone would need to take on that role (and get all of the glory that entails)
  • We have three wireframes which @melchoyce is going to turn into a design. We will need designs for the following pages:
  • landing page
  • individual function page
  • archive page

We also may need:

  • standard narrative page
  • API pages (though @nacin suggested that these would live in the Plugin Dev Handbook)

Here are the wireframes thus far:

Landing Page
Landing Page

Function Page

FunctionPage

Archive Page

archive_page

Please feel free to comment on these, however please focus on the following questions:

  • are there any navigation elements you feel are missing from the landing page?
  • are there any other developer resources you feel should be featured on the landing page?
  • are there any navigational elements missing from the individual function page?
  • are there any content elements missing from the function page?
  • would it be useful to have a page that lists every function, like: https://codex.wordpress.org/Function_Reference?
  • as a developer, are their any elements of a code reference that you would love to see included but that we haven’t allowed for yet?

#devhub