Welcome to the official home of the WordPress documentation team.
This team is responsible for coordinating all documentation initiatives around WordPress, including the Codex (moving to HelpHub and DevHub), handbooks, parts of developer.wordpress.orgWordPress.orgThe 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/, admin help, inline docs, and other general wordsmithing across the WordPress project.
Want to get involved?
There are many ways in which you can help the Docs team. Every small contribution counts and helps! You can report an issue or typo you found in the docs, or even help us write new documentation for parts that are still missing. These are some helpful links to find out more about what we do and how to collaborate:
The Description, Syntax, Parameters and Returns should be converted to inline docs in the function headerHeaderThe 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.. These inline docs are automatically converted and added to the Code Reference.
For our example, refer to this source code. https://core.trac.wordpress.org/browser/tags/5.2/src/wp-includes/plugin.php#L384. As you can see, the function header includes description and @since, @param and @return tags. Those tags form the Description, Syntax, and Parameters for this function and have been automatically added to the Code Reference.
All functions already have inline docs but not with the same level of information as the Codex. A lot of information was dropped during initial function header creation.
These should be migrated to the Explanation field of the Code Reference and are displayed in the “More Information” section.
To edit the Explanation field, your WordPress.orgWordPress.orgThe 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/ account must have been added as an editor role or above on the Developer Reference.
Note: Because it is trivial, you don’t need migrate one line Usage such as
In the tracking spreadsheet, search for ‘Partially done’ rows using the Status column (Column H).
Enter your name in the Editor column (Column F) and change the Status column (Column H) to ‘In Progress’. If you don’t have write permission to the spreadsheet, please DM your Google account to @atachibana on #docs channel.
Open Codex page and Code Reference page and compare them
If Code Reference has full information of Codex, then OK
If Code Reference does not have some information, refer above Codex to Code Reference and migrate missing information on the Codex page to the Code Reference appropriately.
When you create a Ticket to modify the inline documentation, change the status to ‘Waiting’, and leave the ticket number in Notes (Column I).
If you cannot migrate every section, leave a comment in the Notes column (Column I) noting what’s left and change the Status to ‘Partially done’.
From the Codex page, click Edit on right side menu.
Put following message below the language locator, and comment out the current Codex contents using <!-- and -->.
{{Languages|
{{en|WordPress Features}}
{{ja|WordPress Features}}
}}
This page was moved to https://developer.wordpress.org/reference/functions/(function name)/ except above language locator.
Click Show Preview at the bottom of the page and confirm your changes.
Enter the text “Transferred to DevHub” in the Summary box and click Save page.
From the Codex page, click Edit on right side menu.
Put following tag at the top of the page, and adjust the URLURLA specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org.
ReleaseReleaseA release is the distribution of the final version of an application. A software release may be either public or private and generally constitutes the initial or new generation of a new or upgraded application. A release is preceded by the distribution of alpha and then beta versions of the software. this page #Release this page
Change the “In Progress” status to “Done” (Column H).