Welcome to the official home of the WordPress Documentation Team.
This team is responsible for coordinating all documentation initiatives around WordPress, including the handbooks and other general wordsmithing across the WordPress project.
Want to get involved?
Start here to find out more about what we do and how to contribute:
Documentation Issue Tracker on GitHub: Submit any Documentation Team-related issues on GitHubGitHubGitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/
Weekly meetings
Join our discussions of documentation issues here on the blog and on Slack.
The Advanced administration handbook is created and maintained in collaboration with the Hosting team. To contribute to the handbook you can contact either the Documentation or Hosting team.
Communicate with Advanced administration handbook project reps for any clarifications on the tasks and review of your work. All questions can be asked in the actual GitHubGitHubGitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ issue, by pinging any of the project reps.
Updating the page in the handbook is done by merging the PR in the Advanced administration handbook, performed by one of the committers. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to update the pages after the review is completed and content approved.
Report on your progress at the Documentation team meetings – Project updates agenda item.
The Block editor developer handbook is created and maintained in collaboration with the Core team. To contribute to the handbook you can contact either the Documentation or CoreCoreCore is the set of software required to run WordPress. The Core Development Team builds WordPress. team.
Communicate with Block editor end user docs project reps for any clarifications on the tasks and review of your work. All questions can be asked in the actual GitHub issue by pinging any of the project reps.
Updating the page in the handbook is done by merging the PR in the Gutenberg repo, performed by one of the committers. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to merging PRs after the review is completed, and content approved.
Report on your progress at the Documentation team meetings – Project updates agenda item.
Communicate with other More info curators for any clarifications on the tasks and a review of your work. All questions can be asked in the actual GitHub issue, by pinging any of the project reps.
Updating the page in the handbook is usually done by one of the project reps or active contributors who have access to the dashboard where Code reference documentation lives. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to the dashboard for updating the pages after the review is completed and content approved.
Report on your progress at the Documentation team meetings – Project updates agenda item.
An example of a good and detailed More information section can be found on the WP_Query class page. Everything between More information and Methods belongs to the More information section.
Updating the notes in the handbook is usually done by one of the project reps or active contributors who have access to the dashboard where Code reference comments live. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to the dashboard for monitoring and updating the comments
Report on your progress at the Documentation team meetings – Project updates agenda item.
A lot of examples of User contributed notes can be found on the WP_Query class page.
Guidelines
Code should strictly follow WordPress coding standards, and any output should be escaped and internationalised.
Any feedback about the documentation itself should not be published – these are processed as Trac tickets for the core team (e.g. https://core.trac.wordpress.org/ticket/56324)
Prefix all class and function names with wpdocs_
No support requests: immediately trashed
General “thank you” messages should not be published
The ultimate goal is for comments to be valuable, easy to read and follow best practices and coding standards. Code examples should work by copying and pasting, and if necessary, changing some things (e.g. taxonomyTaxonomyA taxonomy is a way to group things together. In WordPress, some common taxonomies are category, link, tag, or post format. https://codex.wordpress.org/Taxonomies#Default_Taxonomies. name, custom post typeCustom Post TypeWordPress can hold and display many different types of content. A single item of such a content is generally called a post, although post is also a specific post type. Custom Post Types gives your site the ability to have templated posts, to simplify the concept. name etc.).
Possible workflows:
A user submitted a note reporting an issue with a DocBlock parameter:
Open a ticket on TracTracTrac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. (example)
Mention the commenter’s WordPress username so they can get Core Props for the contribution
TrashTrashTrash in WordPress is like the Recycle Bin on your PC or Trash in your Macintosh computer. Users with the proper permission level (administrators and editors) have the ability to delete a post, page, and/or comments. When you delete the item, it is moved to the trash folder where it will remain for 30 days. the comment once the ticket is committed
A user submitted a note with a code example:
Check the formatting, escaping, internationalisation and prefixes.
Check if the code is working as expected (testing it in your local WordPress installation may be the best option).
If everything is correct, publish the comment. If issues are small (from the first item) fix them yourself. If the code is not working or even causing errors, try to contact the author (via slack) to fix the issues. If it is not possible to contact the author (e.g. they don’t have a slack account) and you’re not in a position to fix errors, ask other curators for help and leave a comment as pending. If no progress is made and the author hasn’t contacted the team, trash the comment.
Inform the Documentation team of the username so that contributor can get their Docs badge.
Communicate with Common APIs handbook project reps for any clarifications on the tasks and review of your work. All questions can be asked in the actual GitHub issue, by pinging any of the project reps.
Updating the page in the handbook is usually done by one of the project reps or active contributors who have access to the dashboard where Common APIs handbook documentation lives. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to the dashboard for updating the pages after the review is completed and content approved.
Report on your progress at the Documentation team meetings – Project updates agenda item.
Project code name: DevHub, PluginPluginA 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 Project URL: https://developer.wordpress.org/plugins/ Project issues label: plugins Project issues URL: plugins
Responsibilities
Work on Plugin handbook issues in the Issue Tracker repo, whether it’s creating a new page or just fixing a part of an existing one.
Report on progress at the Documentation team meetings – Project updates agenda item.
Communicate with Plugin handbook project reps for any clarifications on the tasks and a review of your work. All questions can be asked in the actual GitHub issue, by pinging any of the project reps.
Updating the page in the handbook is usually done by one of the project reps or active contributors who have access to the dashboard where Plugin handbook documentation lives. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to the dashboard for updating the pages after the review is completed and content approved.
Report on your progress at the Documentation team meetings – Project updates agenda item.
The Themes handbook is created and maintained in collaboration with the Themes team. To contribute to the handbook you can contact either the Documentation or Themes team.
Responsibilities
Work on Theme handbook issues in the Issue Tracker repo, whether it’s creating a new page or just fixing a part of the existing one.
Report on progress at the Documentation team meetings – Project updates agenda item.
Communicate with Themes handbook project reps for any clarifications on the tasks and review of your work. All questions can be asked in the actual GitHub issue, by pinging any of the project reps.
Updating the page in the handbook is usually done by one of the project reps or active contributors who have access to the dashboard where the Theme handbook documentation lives. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to the dashboard for updating the pages after the review is completed and content approved.
Report on your progress at the Documentation team meetings – Project updates agenda item.