Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Handbook Master Thread #10549
This master thread looks at organizing the work and discussion around the Gutenberg Handbook so we can assign tasks and make progress. I'm going to break down the main areas the handbook should cover.
1) High Level Principles
This covers the mission and vision of the Gutenberg project as it spans across its phases. It frames the effort and informs all the areas of the projects, across developers, designers, and users.
2) Human Interface Guidelines: Design and Dev
These are the principles that govern the approach to building blocks and interfaces for the editor. The main objective is to accurately convey the dos and don'ts to help inform developers and designers about the fundamental aspects of block building towards achieving a consistent and highly usable ecosystem. This also includes UI component documentation and best practices.
3) Code and API Documentation
Currently the bulk of the documents in the handbook are around documenting the code, APIs, and components available. Most of these documents should be synchronized with the source code so that it doesn't grow stale.
4) Resources and References
Showing examples is always a great aid to learning, as imitation is usually the path of least resistance to get started. It also recognizes that the WordPress community is vast and powerful, and that no single resource can be exhaustive enough.
This would include more step-by-step tutorials similar to how the "block" section currently reads. It'd help people get started and guide them through the increasing complexity, introducing concepts as needed. It should be complementary to the interface guidelines and the general documentation.
Action items are to be tackled in the milestone: https://github.com/WordPress/gutenberg/milestone/50
This is just an initial set of things we should start dividing efforts around.
Some user-facing pages to add to wordpress.org/gutenberg were suggested on a Trac ticket as well. Paraphrased below.
Here I've quoted and ported the most important part of that ticket, edited here for a little bit of clarity:
Also, @gidgey has expressed interest in helping wrangle folks from the Marketing team, if that's helpful.
Hi everyone —
As promised in a few places (namely in this week's #core meeting) I've posted over in #core-docs in Slack about kicking off a weekly meeting for Gutenberg handbook work (registration required).
For anyone interested in pitching in on the Gutenberg handbook, please pop over there and comment on the potential meeting times! Thanks :)
Suggestion: it'd be nice to get more examples of how to use the sidebar API plugins, like