Help research content creation workflows for the code reference

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:

Onboarding to Documentation Team: An overview of what we do and how to collaborate
Documentation Issue Tracker on GitHub: Submit any Documentation Team-related issues on GitHubGitHub GitHub 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 documentation team holds weekly office hours and monthly Contributor Days on each Tuesday of the month in the #docs SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. channel. It’s also where you can contact the team at any time outside meetings.

The code reference is rumbling along – it’s now possible for people to submit examples, source code can be viewed from pages, and we’re working on upvoting functionality. But before we can embark on the grand codex migrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies., we need to have a way for people to create user-generated content. We’ve discussed this before but made no major progress.

What we want: A simple way for people to add supplementary content and information to the code reference.

How you can help: We need example of how other code references allow users to add explanations and content.

Please respond to this post with examples. Just some screenshots would be great. When we’ve collected a bunch of them we can go through them and see what inspiration we can get for our own reference.

#devhub

Siobhan 5:23 am on July 9, 2014

Code Reference: PHP.net

Brief outline

PHP.net uses “user contributed notes” in which users can contribute both examples and narrative explanations in one box.

Workflow

1. On function page click “add a note”

2. User redirected to instructions page with form for submitting note at the bottom

Want to get involved?

Weekly meetings

Share this: