Current Docs Projects

Priority Priority

A list of priorities related to content work:

  1. HelpHub block editor (Gutenberg) document modification
  2. Content Migration from Codex to DevHub (Code Reference)
  3. Common APIs Handbook

Also HelpHub development tasks are described here.

HelpHub block editor (Gutenberg) document modification HelpHub block editor (Gutenberg) document modification

WordPress Version 5.0 introduced the Block Editor (code name: Gutenberg), and we need new pages for block editor based on existing page that assumes classic editor.

For detail steps, refer https://make.wordpress.org/docs/handbook/helphub/migrating-articles/#gutenberg-document-modification

Top ↑

Content Migration from Codex to DevHub (Code Reference) Content Migration from Codex to DevHub (Code Reference)

All Functions, Hooks, Filters and Classes have inline documentations in the header parts and they are automatically converted to Code Reference. But some of them dropped detail information described in Codex during its migration. This project complement it and redirect Codex page to Code Reference.

For more detail information, refer this page.

Top ↑

Common APIs Handbook Common APIs Handbook

Common APIs Handbook serves as a clearinghouse for documentation on all APIs present within the WordPress software as well as APIs available from the WordPress.org ecosystem.

For detail steps, refer https://make.wordpress.org/docs/handbook/documentation-team-handbook/common-apis-handbook/


Top ↑

Past Projects: Past Projects:

Top ↑

HelpHub HelpHub

All end-user related content on the Codex has been migrated to the new HelpHub. (https://wordpress.org/support) HelpHub is currently in the development phase and is going to be the ultimate home for all user documentation as well as the support forums.

Please refer this spreadsheet to track status of HelpHub content tasks.

HelpHub migration (done) HelpHub migration (done)

Docs team picked up Codex pages based on the number of views and migrated to HelpHub:

  • 105 Phase-1 pages
  • 351 Version pages
  • 54 Phase-2 pages

Top ↑

HelpHub redirection HelpHub redirection

We need show the warning text at the top of Codex page so that it can tell to visitor that this page was transferred to HelpHub. (e.g. Refer this page)

For detail steps, refer https://make.wordpress.org/docs/handbook/helphub/migrating-articles/#transferring-codex-page-to-helphub

These are earlier projects that have been done by the Documentation team. These are currently considered finished and are located here for historical reasons only.

Top ↑

Inline Documentation Inline Documentation

» Project Page

Inline documentation for WordPress core is an ongoing project of more technically-minded docs contributors. Work centres primarily on improving the completeness and accuracy of existing code documentation in the WordPress source code, as well as adding new docs.

Work is also being done to bring legacy inline docs into alignment with the official PHP Documentation Standards.

Top ↑

Codex Migration Codex Migration

» Project Page

Content from the function references in the Codex is being migrated from the Codex to the Code Reference on the new Developer Hub. As of Spring 2016, all examples have been migrated and work continues to migrate and redirect remaining useful content.

Top ↑

Admin help pages Admin help pages

The admin help in WordPress is the help in the admin panel. The Docs team will sometimes help with updating this documentation. There is currently an effort to create a plugin that will improve the admin help experience.

Top ↑

Developer Handbooks Developer Handbooks

» Project Page

For the last couple of years, members of the docs team have been working on developer handbooks that largely serve to curate useful information from the Codex and supplement with new, accurate, vetted information simultaneously.

In 2014, v1.0 of the Plugin Developer Handbook was published on the new Developer Hub. In 2016, a beta form of the REST API Handbook was released. Work continues on finishing v1.0 of the Theme Developer Handbook.