Docs Projects

Priority Priority

A list of priorities related to content work:

  1. Content MigrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. from Codex to DevHub (Code Reference)

Also HelpHub development tasks are described here.

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

All Functions, HooksHooks In WordPress theme and development, hooks are functions that can be applied to an action or a Filter in WordPress. Actions are functions performed when a certain event occurs in WordPress. Filters allow you to modify certain functions. Arguments used to hook both filters and actions look the same., Filters and Classes have inline documentations in the headerHeader The header of your site is typically the first thing people will experience. The masthead or header art located across the top of your page is part of the look and feel of your website. It can influence a visitor’s opinion about your content and you/ your organization’s brand. It may also look different on different screen sizes. 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 ↑

Current Projects Current Projects

Top ↑

Translating HelpHub Translating HelpHub

Top ↑

Past Projects: Past Projects:

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.orgWordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/ ecosystem.

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

Top ↑

HelpHub blockBlock Block is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. editor (GutenbergGutenberg The Gutenberg project is the new Editor Interface for WordPress. The editor improves the process and experience of creating new content, making writing rich content much simpler. It uses ‘blocks’ to add richness rather than shortcodes, custom HTML etc. https://wordpress.org/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 ↑

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 coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. 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 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 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 betaBeta A pre-release of software that is given out to a large group of users to trial under real conditions. Beta versions have gone through alpha testing in-house and are generally fairly close in look, feel and function to the final product; however, design changes often occur as part of the process. form of the REST APIREST API The REST API is an acronym for the RESTful Application Program Interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data. It is how the front end of an application (think “phone app” or “website”) can communicate with the data store (think “database” or “file system”) https://developer.wordpress.org/rest-api/. Handbook was released. Work continues on finishing v1.0 of the Theme Developer Handbook.

Last updated: