Title: documentation – Make WordPress Core

---

#  Tag Archives: documentation

 [  ](https://profiles.wordpress.org/welcher/) [Ryan Welcher](https://profiles.wordpress.org/welcher/)
5:23 pm _on_ March 28, 2023     
Tags: block editor handbook, [core ( 721 )](https://make.wordpress.org/core/tag/core/),
[core-editor ( 745 )](https://make.wordpress.org/core/tag/core-editor/), documentation,
[gutenberg ( 537 )](https://make.wordpress.org/core/tag/gutenberg/)   

# 󠀁[Introducing a new block editor handbook scrub](https://make.wordpress.org/core/2023/03/28/introducing-a-new-block-editor-handbook-scrub/)󠁿

There is currently a large number of outstanding issues in the 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/](https://wordpress.org/gutenberg/) repository
with the `[Type] Developer Documentation` label. We think that it would help to 
bring the 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 handbook more up-to-date and correct any errors and/or omissions that may
exist if some of the backlog of issues were addressed.

Starting [Thursday, March 30, 2023, at 13:00](https://www.timeanddate.com/worldclock/fixedtime.html?iso=20230330T1300),
we will begin holding a weekly meeting to review and triagetriage The act of evaluating
and sorting bug reports, in order to decide priority, severity, and other factors.
developer documentation issues in the Gutenberg repository. These meetings will 
take place every Thursday at 13:00 UTC in the [#core-editor](https://make.wordpress.org/core/tag/core-editor/)
room.

During these meetings we will:

 1. Review issues labeled with [[Type] Developer Documentation](https://github.com/WordPress/gutenberg/issues?q=is%3Aopen+is%3Aissue+label%3A%22%5BType%5D+Developer+Documentation%22)
    starting with the oldest and moving forward.
 2. Decide on what ( if any ) action to take for the issue and if possible, assign 
    it.

This is a great opportunity for anyone looking to contribute to the Gutenberg project
or move their tickets forward. 

[@welcher](https://profiles.wordpress.org/welcher/) and [@mburridge](https://profiles.wordpress.org/mburridge/)
will facilitate the meetings but anyone who is interested in leading them is more
than welcome.

We hope you will join us. What do you think? Any questions? Leave a comment below.

_Thanks to [@greenshady](https://profiles.wordpress.org/greenshady/) and [@mburridge](https://profiles.wordpress.org/mburridge/)
for reviewing this post_

[#block-editor-handbook](https://make.wordpress.org/core/tag/block-editor-handbook/),
[#core](https://make.wordpress.org/core/tag/core/), [#documentation](https://make.wordpress.org/core/tag/documentation/),
[#gutenberg](https://make.wordpress.org/core/tag/gutenberg/)

 [  ](https://profiles.wordpress.org/audrasjb/) [Jb Audras](https://profiles.wordpress.org/audrasjb/)
9:04 pm _on_ May 3, 2021     
Tags: [5.8 ( 99 )](https://make.wordpress.org/core/tag/5-8/),
[developer-documentation ( 8 )](https://make.wordpress.org/core/tag/developer-documentation/),
[devhub ( 2 )](https://make.wordpress.org/core/tag/devhub/), [docs ( 10 )](https://make.wordpress.org/core/tag/docs/),
documentation, helphub   

# 󠀁[Docs Focus role & workflow during WordPress release cycle](https://make.wordpress.org/core/2021/05/03/docs-focus-role-workflow-during-wordpress-release-cycle/)󠁿

This is a summary of a discussion which happened during previous Docs Team meetings
and also a proposal for WordPress 5.8.

During the previous weekly Docs team meetings, a discussion started about how the
[Documentation team](https://make.wordpress.org/docs) could be better involved during
WordPress release cycles.

In recent years, all new versions of WordPress have had a person responsible for
the “Docs” focus ([@justinahinon](https://profiles.wordpress.org/justinahinon/) 
for 5.3 and 5.5, [@audrasjb](https://profiles.wordpress.org/audrasjb/) for 5.4 and
5.7, [@sncoker](https://profiles.wordpress.org/sncoker/), [@m_butcher](https://profiles.wordpress.org/m_butcher/)
and their cohort for 5.6). But even if all the dev notesdev note Each important 
change in WordPress Core is documented in a developers note, (usually called dev
note). Good dev notes generally include a description of the change, the decision
that led to this change, and a description of how developers are supposed to work
with that change. Dev notes are published on Make/Core blog during the beta phase
of WordPress release cycle. Publishing dev notes is particularly important when 
plugin/theme authors and WordPress developers need to be aware of those changes.
In general, all dev notes are compiled into a Field Guide at the beginning of the
release candidate phase. and the Field GuideField guide The field guide is a type
of blogpost published on Make/Core during the release candidate phase of the [WordPress release cycle](https://make.wordpress.org/core/handbook/about/release-cycle/).
The field guide generally lists all the dev notes published during the beta cycle.
This guide is linked in the about page of the corresponding version of WordPress,
in the release post and in the HelpHub version page. (which are the main tasks of
the Docs Focus) are published, the Docs team pointed out that it’s difficult for
them to make sure all the end-user documentation (HelpHub) and the developer documentation(
DevHub) are up to date after a new version is released.

## WordPress release Docs Focus

[@milana_cap](https://profiles.wordpress.org/milana_cap/) ([@zzap](https://profiles.wordpress.org/zzap/)
on SlackSlack Slack is a Collaborative Group Chat Platform [https://slack.com/](https://slack.com/).
The WordPress community has its own Slack Channel at [https://make.wordpress.org/chat/](https://make.wordpress.org/chat/))
is the [Docs Focus Lead for WordPress 5.8](https://make.wordpress.org/core/5-8/).
The role of Docs Focus lead includes the responsibilities listed below. For each
responsibility, one or more deputies will help the release Docs Focus lead but Milana
Cap will remain the unique Docs reference person for the Release squad.

### Developers notes wrangling on Make/CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress.

 * Keep track of changes within the release that require dev notes
   (changes that
   require a dev notedev note Each important change in WordPress Core is documented
   in a developers note, (usually called dev note). Good dev notes generally include
   a description of the change, the decision that led to this change, and a description
   of how developers are supposed to work with that change. Dev notes are published
   on Make/Core blog during the beta phase of WordPress release cycle. Publishing
   dev notes is particularly important when plugin/theme authors and WordPress developers
   need to be aware of those changes.In general, all dev notes are compiled into
   a Field Guide at the beginning of the release candidate phase. must be labelled
   with the `needs-dev-note` workflow keyword)
 * Ensure all dev notes are written with enough time to proofread, reviewed, and
   published prior to the field guide (which is published by the Docs Focus lead
   at the same time as release candidaterelease candidate One of the final stages
   in the version release cycle, this version signals the potential to be a final
   release to the public. Also see [alpha (beta)](https://make.wordpress.org/core/tag/documentation/?output_format=md#alpha-beta).
   1)
 * Coordinate with the participants of those tickets with the best understanding
   of the changes (the committercommitter A developer with commit access. WordPress
   has five lead developers and four permanent core developers with commit access.
   Additionally, the project usually has a few guest or component committers - a
   developer receiving commit access, generally for a single release cycle (sometimes
   renewed) and/or for a specific component., component maintainers, the contributor
   who owns the ticketticket Created for both bug reports and feature development
   on the bug tracker.) to draft dev notes
 * If a ticket participant is not available to write a dev note, finding someone
   to write one, or writing one yourself
 * Proofread and review dev notes as they are available from the Documentation Wrangling
   team
    - Verify code examples
    - Make suggestions for additional examples
    - Ensure the developer notes accurately and thoroughly describe the problem,
      solution, and identify proper usage of the changes

### End-user documentation wrangling on HelpHub

 * Keep track of changes within the release that require changes on HelpHub
   (changes
   that require HelpHub changes (whether it’s a new page or just an update on existing
   ones) must be labelled with the `needs-codex` workflow keyword)
 * Ensure any documentation pages required for new features are created before the
   release
 * Ensure any existing documentation page for changes on existing features are ready
   to be updated (the day of the final release)
 * Write and publish the release version page on HelpHub
 * Update WordPress versions page on the Codex

### Developer documentation wrangling on DevHub

 * Keep track of changes within the release that require changes on DevHub
   (changes
   that require DevHub changes –whether it’s a new page or just an update on existing
   ones– must be labelled with the `needs-docs` workflow keyword)
 * Ensure any documentation sections required for new features are ready to be updated(
   they are updated a few days **after** the final release, once the DevHub automatic
   parser has synchronized the documentation)
    - “More information” sections on DevHub ([example](https://developer.wordpress.org/reference/classes/wp_query/#more-information))
    - 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 Developer Docs
 * Ensure any existing documentation sections for changes on existing features are
   ready to be updated (they are also updated a few days **after** the final release)
    - “More information” sections on DevHub
 *  - Block editor Developer Docs

## Workflow

A new spreadsheet will be created by the docs focus lead. The previous spreadsheet
was built for dev notes over all, with a simple “HelpHub” column. For WordPress 
5.8, the Docs team proposed to use a tab for each responsibility: Dev notes, HelpHub
and DevHub, so they can be equally wrangled. Also, Core changes from TracTrac An
open source project by Edgewall Software that serves as a bug tracker and project
management tool for WordPress. will be separated from Block Editor changes from 
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 by the repository owner. [https://github.com/](https://github.com/).

_Reviewed by [@milana\_cap](https://profiles.wordpress.org/milana_cap/) and [@jeffpaul](https://profiles.wordpress.org/jeffpaul/)._

[#5-8](https://make.wordpress.org/core/tag/5-8/), [#developer-documentation](https://make.wordpress.org/core/tag/developer-documentation/),
[#devhub](https://make.wordpress.org/core/tag/devhub/), [#docs](https://make.wordpress.org/core/tag/docs/),
[#documentation](https://make.wordpress.org/core/tag/documentation/), [#helphub](https://make.wordpress.org/core/tag/helphub/)

 [  ](https://profiles.wordpress.org/rachelbaker/) [Rachel Baker](https://profiles.wordpress.org/rachelbaker/)
11:49 pm _on_ September 7, 2015     
Tags: documentation, [feature plugins ( 122 )](https://make.wordpress.org/core/tag/feature-plugins/),
[rest-api ( 107 )](https://make.wordpress.org/core/tag/rest-api/)   

# 󠀁[WP REST API v2 Documentation Meeting](https://make.wordpress.org/core/2015/09/07/wp-rest-api-v2-docs/)󠁿

Our [current documentation](http://v2.wp-api.org/) for version 2 of the WP 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/](https://developer.wordpress.org/rest-api/)
is minimal at best. We need your help to build a resource for developers looking
to use the WP REST API v2.

Please join us [Wednesday 23:00 UTC 2015](https://www.timeanddate.com/worldclock/fixedtime.html?iso=20150422T2300)
in [#core-restapi](https://wordpress.slack.com/messages/core-restapi/) to discuss
our documentation workflow, pain-points, and areas of need.

We are especially interested in you if you have:

 * experience using WP REST API v2
 * tried to use WP REST API v2, but the lack of documentation drove you away
 * experience with any of our authentication plugins
 * front-end skills and ideas on how we can improve our presentation
 * a passion for writing documentation
 * a desire to see the WP REST API in CoreCore Core is the set of software required
   to run WordPress. The Core Development Team builds WordPress.
 * nothing else to do during our meeting time

[#documentation](https://make.wordpress.org/core/tag/documentation/), [#feature-plugins](https://make.wordpress.org/core/tag/feature-plugins/),
[#rest-api](https://make.wordpress.org/core/tag/rest-api/)

 [  ](https://profiles.wordpress.org/ryan/) [Ryan Boren](https://profiles.wordpress.org/ryan/)
6:15 am _on_ September 18, 2008     
Tags: documentation, [phpdoc ( 3 )](https://make.wordpress.org/core/tag/phpdoc/)

# 󠀁[Heaps more inline documentation from Jac …](https://make.wordpress.org/core/2008/09/18/heaps-more-inline-documentation-from-jac/)󠁿

Heaps more inline documentation from Jacob landed.

[#documentation](https://make.wordpress.org/core/tag/documentation/), [#phpdoc](https://make.wordpress.org/core/tag/phpdoc/)