Gutenberg developer documentation – Meeting Notes December 2nd


Attendance: @paaljoachim, @collinsmbaka, @justinahinon.

Agenda: https://make.wordpress.org/docs/2020/11/30/gutenberg-developer-documentation-zoom-meeting-agenda/

Video recording: https://drive.google.com/file/d/1y4PUVjx28AfYH9d75zH_dAyNAt-XYmgo/view?usp=sharing

Summary

In short, we discussed the genesis of the project to restructure the block editor’s developer documentation. Then we went through the current structure of the documentation, the different issues that have already been opened and the site that @paaljoachim created to iterate our efforts.

We finally discussed the next steps for the project.

Next steps

Keeping track of all the documentation improvement work

GitHub issues related to documentation improvement will be tracked on this project board on the GitHub Gutenberg repository. These issues will be labeled developer-docs so that they can be found easily.

Gathering information on how the documentation is generated

An indispensable thing to do too is to know and retrieve information on how, when and how often the documentation on the site is generated.

Improve the site “landing page”

The first page you come across when going to the block editor’s developer documentation site is “Project Overview”. As its name suggests, this page is supposed to give developers a general overview of the project, its main parts and allow them to quickly start developing for Gutenberg.

Some issues have already been created for this on the GitHub repository. You can give your feedbacks to them or create new ones if needed.

New structure (summary) for the documentation

This step is highly correlated with the previous one. The documentation should be structured in such a way that it is easily accessible and also has a certain logical order.

For this step, it is important to keep an eye on the different documentation use cases that were identified earlier.

#developer-documentation