Docs Chat Update 15th February

Chat Log

We had a long chat last night and lots of issues were covered. Here’s what we discussed:

  • query_posts in Codex – query_posts is recommended at various places in the Codex as well as being used in code examples. It was pointed out that query_posts shouldn’t be recommended and that these pages should be reviewed and revised.
  • handbooks – CCH is ongoing. The Theme and PluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party development handbook schedules need to be revised as I wrote them to write in a linear manner but people don’t seem to be too inclined to do that.
  • handbook office hours – following the model coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. uses for features, it would be worth having regular office hours for the handbooks so that people can come along with various issues.
  • Handbook Wireframes – we all agreed that we like the handbook wireframes but no one was very keen on the floating ToC. Discussions about this are ongoing.
  • better code reference – the parser is complete and @rmccue is putting together some mockups for the function pages.
  • Handbook versions and revisionsRevisions The WordPress revisions system stores a record of each saved draft or published update. The revision system allows you to see what changes were made in each revision by dragging a slider (or using the Next/Previous buttons). The display indicates what has changed in each revision. – we discussed surfacing revisions for documentation. This is on hold until 3.6 is complete.
  • code documentation standards – I was asked on Twitter last week about code documentation standards. We agreed that this is something that we would like to have, but that the standards will be drawn up after the function reference is complete.

Actions

  • Siobhan to post something about query_posts to the make/docs P2P2 P2 or O2 is the term people use to refer to the Make WordPress blog. It can be found at https://make.wordpress.org/.
  • talk to theme and plugin dev editors about reviewing schedule
  • @rmccue to mock up function pages
  • Siobhan to complete documentation survey and get it circulated. Need to add section of developer questions.

#chat-recap