Add READMEs to all block-editor components

[youknowriad]

The Block Editor package in Gutenberg is full of components used to build blocks or block editors. These components lack documentation.

This issue is a tracking issue for the documentation effort to add READMEs to all these components.

If you want to help with this:

• Grab a component in the block-editor package that lacks a README
• Comment on the issue that you want to help document this component
• Write a README.md file for this component following the same format as the already documented components.

[alita-moore]

I want to make a README for the block-alignment-matrix-toolbar, issue #22516 ; How should I proceed? Is this a README for the issue or for the component?

[youknowriad]

@alita-moore yes, a README is needed for that component. so you should add a file to the component folder name it README.md, copy some existing component README to get the "base template" and fill it.

[alita-moore]

Okay,

This README

Doesn't have a very defined structure. Are you saying to copy the format in terms of linking to the parent directory?

[youknowriad]

Yes, this is not the best example. This might work better https://github.com/WordPress/gutenberg/blob/master/packages/components/src/button/README.md

[alita-moore]

Oh okay, that's much better.

Thank you for info, I'll get cracking 👩‍💻

[JustinyAhin]

Working on a pull for BlockBreadcrumb componenent https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-breadcrumb

[JustinyAhin]

I've identified all the packages that haven't yet a README.

[talldan]

Just thought I'd mention that I have a few months of leave coming up, so won't be able to work on these for a while. I notice I was assigned a few.

[mburridge]

Hi @talldan, please feel free to re-assign those to someone else that you deem has the technical knowledge required to create the readme. Thanks.