Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update top-level README for Block Editor Handbook #35905

Open
mkaz opened this issue Oct 24, 2021 · 1 comment
Open

Update top-level README for Block Editor Handbook #35905

mkaz opened this issue Oct 24, 2021 · 1 comment
Labels
[Type] Documentation

Comments

@mkaz
Copy link
Member

@mkaz mkaz commented Oct 24, 2021

What problem does this address?

The current top-level page for the Block Editor Handbook is geared towards the post editor being the primary Gutenberg tool, with the upcoming release of WP 5.9 the Block Editor Handbook covers many topics beyond just the post editor.

What is your proposed solution?

I'm open to suggestions on what to include. There are a lot of topics covered in the handbook, from building blocks to global styles, and block themes.

A couple of suggestions for the page, but welcome your thoughts:

  • Update the lead image - The current image was used to highlight sections in the post editor, it is not really feasible to try to cover all the topics the handbook now covers. So, we probably want something more aspirational, open to suggestions.

  • Review and organize the content - The main focus of the handbook previously was on creating blocks, but with WP 5.9 there are block themes, settings, styles, and templates that will need prominence. How best do we guide the developers?
@mkaz mkaz assigned annezazu and unassigned annezazu Oct 24, 2021
@annezazu
Copy link
Contributor

@annezazu annezazu commented Oct 25, 2021

Thanks for kicking this off! Whew, great call out to get this page updated. Keen to help as I can. I agree with both of your suggestions.

How best do we guide the developers?

This might be overkill but I imagine almost three sections with rough categories (this is off the top of my head and not meant to be fully comprehensive):

Beginner:

  • Help with testing.
  • Build your own custom block patterns (can link to workshop).

Intermediate:

  • Contribute to the codebase with good first issues.
  • Create custom block variations
  • Create custom block styles

Advanced:

  • Contribute to the codebase outside of good first issues.
  • Build a block theme.
  • Adopt pieces of FSE for your theme.
  • Create a custom block.

In general, it feels important to move away from creating a custom block as the sole way to develop with Gutenberg or create things for clients, especially since custom blocks aren't always the best solution or the only.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
[Type] Documentation
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
@mkaz @annezazu