WDS Helps To Improve Documentation in WordPress 3.7

For the 3.7 release, WebDevStudios’ own Brian Richards and dozens of others turned their collective focus to documenting the many hooks that WordPress provides for developers.

The hooks docs initiative was birthed from a conversation between Andrew Nacin and Jon Cave that I overheard during the WordCamp San Francisco After Party. They were talking about something called a “hash notation” for easily documenting arrays in inline docs, and improving the documentation efforts of WordPress, and I wanted to know more. By the end of the night I was convinced this would be a perfect way to document the multitude of hooks littered throughout WordPress Core, and a perfect way for me (and others) to contribute to WordPress. – Brian Richards

During WordCamp San Fransisco contributor day, Brian connected with Andrew Nacin, Jon Cave, Eric Lewis, and Drew Jaynes. They sat down and began working out the logistics of updating the documentation together.

Fast-forward several weeks, Drew Jaynes and Kim Parsell put in a lot of hours writing and refining PHP Documentation Standards pages for the WordPress handbook. Brian Richards helped define and create the Hook Documentation standards portion, and they wrote up a few leading posts for After this they hit the ground running.

Eric, Kim, Drew and myself comprised the core hook docs team, and we’ve held meetings every week since the project started. Drew and Kim shouldered much of the work reviewing other peoples patches, and Drew was even granted temporary commit access to help make the process flow more smoothly (congrats, Drew!).

At this moment, 74 of the 185 files containing hooks have been documented. There is still much to be done, and this initiative will continue to thrive well into (and possibly through) WordPress 3.8. – Brian Richards

We want to thank everyone who contributed to the release of WordPress 3.7 including WDS’ Brian Richards and Michael Beckwith. There is still a lot more work to do and anyone looking to help can get involved by reading this post on make/core:


Have a comment?

Your email address will not be published. Required fields are marked *

accessibilityadminaggregationanchorarrow-rightattach-iconbackupsblogbookmarksbuddypresscachingcalendarcaret-downcartunifiedcouponcrediblecredit-cardcustommigrationdesigndevecomfriendsgallerygoodgroupsgrowthhostingideasinternationalizationiphoneloyaltymailmaphealthmessagingArtboard 1migrationsmultiple-sourcesmultisitenewsnotificationsperformancephonepluginprofilesresearcharrowscalablescrapingsecuresecureseosharearrowarrowsourcestreamsupporttwitchunifiedupdatesvaultwebsitewordpress