Editing Articles

Overview Overview

As part of the official documentation roadmap devised by the Docs team in Cincinnati in 2013, much of the work the docs team is doing of late centers around migrating useful content from the Codex to official handbooks or to the developer hub, with the ultimate goal being to eventually shut down the Codex.

NOTE: User documentation such as installation, maintenance and how-to-use guide are migrated into ‘HelpHub’. Refer https://make.wordpress.org/docs/handbook/helphub/

Top ↑

Codex to Code Reference Codex to Code Reference

Already some pages are migrated from Codex to Code Reference. Let’s compare two version of add_action to know which parts are converted to where:

Codex (archives) :
https://codex.wordpress.org/index.php?title=Function_Reference/add_action&oldid=152725
Code Reference:
https://developer.wordpress.org/reference/functions/add_action/

Description, Syntax and Parameters Description, Syntax and Parameters

They should be converted to inline docs in the function header. In our example, refer this source code. https://core.trac.wordpress.org/browser/tags/5.2/src/wp-includes/plugin.php#L384 As you see, function header includes description and @since, @param and @return tags. Those are inline docs, and automatically, they are converted to the Code Reference.

Already, all functions have inline docs but not have the same level information with Codex. It means many information were dropped during initial function header creation.
For inline docs, refer this page:
https://make.wordpress.org/docs/handbook/code-reference/inline-documentation/
You need some development skill to build the environment.

Top ↑

Usage and Programming Topics Usage and Programming Topics

They should be migrated to the Explanation field of Code Reference. This is displayed as “More Information” section in the Code Reference.
To edit the Explanation field, your WordPress.org account must have been added as an editor role or above on the Developer Reference. Need to be added? Go to the #docs channel on slack and ask someone to add you.

Top ↑

Examples Examples

Examples are migrated as User Comments of each page. Refer this document for more details:
https://make.wordpress.org/docs/handbook/code-reference/editing-articles/migrating-from-codex/

Top ↑

Getting Started Getting Started

To begin, we’re tracking migration of Codex to the Code Reference in this spreadsheet: 
https://docs.google.com/spreadsheets/d/15hpEbbnuWJZ0DJafyCeG3CFRMtSxX1gY-RObrrjzzdw/edit#gid=0

First reserve the page where you want to edit.

1) From above worksheet, search ‘Partially done’ row in Status (Column H)
2) Enter your name in Editor (Column F) and change ‘In Progress’ status

Migrate or convert the Codex to Code Reference

3) Refer above “Codex to Code Reference” and migrate every contents to Code Reference.
4) If you cannot complete the every contents, then leave the comment in ‘Notes’ (Column-I) and change the status to ‘Partially done’. You don’t need redirecting the page.

Redirect the page from Codex to Code Reference.

When Codex page has language locator
i) From codex page, click Edit on right side menu.
ii) Put following message below the language locator, and comment out the current Codex contents by “<–” and “–>”.

{{Languages|
{{en|WordPress Features}}
{{ja|WordPress Features}}
}}
This page was moved to https://wordpress.org/support/article/< HelpHub page> except above language locator.

iii) Click bottom Show preview and confirm your changes.
iX) Enter the text “Transferred to HelpHub” in the Summary box and click Save page.

When Codex page does not have language locator
i) From codex page, click Edit on right side menu.
ii) Put following tag at the top of the page, and adjust the URL.

{{#dotorgredirect: https://developer.wordpress.org/reference/functions/(function name)/}}

iii) Enter the text “Transferred to HelpHub” in the Summary box and click Save page.

NOTE: Once you save the page, viewing the page will be redirected to HelpHub page. If you want to modify the saved page, add &action=edit to the URL.
e.g. https://codex.wordpress.org/index.php?title=Function_Reference/add_action&action=edit

Release this page
5) Change “In Progress” status to “Redirected” (Column H)

Top ↑

Progress Stats Progress Stats

https://docs.google.com/spreadsheets/d/15hpEbbnuWJZ0DJafyCeG3CFRMtSxX1gY-RObrrjzzdw/edit#gid=1576070270