Gutenberg: 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.

[JustinyAhin]

Block editor packages that still lack README

• [ ] [alignment-toolbar](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/alignment-toolbar) -- https://github.com/WordPress/gutenberg/pull/25210 --- @JustinyAhin
• [ ] [block-actions](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-actions) (not exported)
• [ ] [block-alignment-toolbar](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-alignment-toolbar) -- https://github.com/WordPress/gutenberg/pull/25212 --- @JustinyAhin
• [x] [block-breadcrumb](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-breadcrumb) --- https://github.com/WordPress/gutenberg/pull/24827 - @JustinyAhin
• [ ] [block-caption](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-caption) --- @JustinyAhin (not exported)
• [x] [block-card](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-card) -- https://github.com/WordPress/gutenberg/pull/25150 --- @JustinyAhin (not exported)
• [ ] [block-controls](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-controls)
• [ ] [block-draggable](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-draggable) (not exported)
• [ ] [block-edit](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-edit)
• [x] [block-format-controls](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-format-controls) --- https://github.com/WordPress/gutenberg/pull/25573 @jorgefilipecosta
• [x] [block-icon](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-icon) -- https://github.com/WordPress/gutenberg/pull/24947 --- @JustinyAhin
• [x] [block-inspector](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-inspector) --- https://github.com/WordPress/gutenberg/pull/24929 @JustinyAhin
• [ ] [block-list-appender](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-list-appender) (not exported)
• [ ] [block-list](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-list)
• [ ] [block-mobile-toolbar](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-mobile-toolbar)
• [x] [block-mover](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-mover) --- https://github.com/WordPress/gutenberg/pull/24851 - @JustinyAhin
• [ ] [block-navigation](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-navigation) --- https://github.com/WordPress/gutenberg/pull/24882 - @JustinyAhin
• [x] [block-parent-selector](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-parent-selector) --- https://github.com/WordPress/gutenberg/pull/24962 - @JustinyAhin (not exported)
• [ ] [block-patterns-list](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-patterns-list) --- https://github.com/WordPress/gutenberg/pull/24983 - @JustinyAhin (not exported)
• [ ] [block-selection-clearer](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-selection-clearer)
• [ ] [block-settings](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-settings) (not exported)
• [ ] [block-styles](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-styles) (not exported)
• [x] [block-switcher](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-switcher) -- not exported
• [ ] [block-toolbar](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-toolbar) -- https://github.com/WordPress/gutenberg/pull/25245 --- @JustinyAhin
• [x] [block-types-list](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-types-list) --- https://github.com/WordPress/gutenberg/pull/25066 - @JustinyAhin (not exported)
• [ ] [block-variation-picker](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/block-variation-picker) --- https://github.com/WordPress/gutenberg/pull/24995 - @JustinyAhin
• [ ] [caption](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/caption) --- @vcanales (not exported)
• [ ] [color-palette](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/color-palette) --- @vcanales
• [ ] [color-style-selector](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/color-style-selector) --- @vcanales (not exported)
• [ ] [color-gradients](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/colors-gradients) --- @vcanales
• [ ] [colors](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/colors) --- @vcanales
• [ ] [contrast-checker](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/contrast-checker) - https://github.com/WordPress/gutenberg/pull/25570 --- @itsjonq
• [x] [copy-handler](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/copy-handler) -- https://github.com/WordPress/gutenberg/pull/25342 --- @JustinyAhin
• [ ] [default-block-appender](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/default-block-appender)
• [ ] [default-style-picker](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/default-style-picker) (not exported)
• [ ] [editor-styles](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/editor-styles) (not exported)
• [ ] [floating-toolbar](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/floating-toolbar) (not exported)
• [x] [focus-detector](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/focus-detector) --- #25561 @mcsf (not exported)
• [x] [font-sizes](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/font-sizes) --- https://github.com/WordPress/gutenberg/pull/25568 @jorgefilipecosta
• [ ] [gradient-picker](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/gradient-picker) --- (not exported)
• [x] [gradients](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/gradients) --- @georgeh
• [ ] [inserter-list-item](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/inserter-list-item) -- https://github.com/WordPress/gutenberg/pull/25116 --- @JustinyAhin (not exported)
• [ ] [inserter-menu-extension](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/inserter-menu-extension)
• [ ] [inserter](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/inserter)
• [ ] [inspector-advanced-controls](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/inspector-advanced-controls) --- #25566 @mcsf
• [ ] [keyboard-shortcuts](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/keyboard-shortcuts) -- https://github.com/WordPress/gutenberg/pull/25284 --- @JustinyAhin (not exported)
• [ ] [line-height-control](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/line-height-control) -- https://github.com/WordPress/gutenberg/pull/25303 --- @JustinyAhin
• [ ] [multi-select-scroll-into-view](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/multi-select-scroll-into-view)
• [x] [multi-selection-inspector](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/multi-selection-inspector) -- https://github.com/WordPress/gutenberg/pull/25306 --- @JustinyAhin (not exported)
• [ ] [navigable-toolbar](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/navigable-toolbar) -- @georgeh
• [ ] [page-template-picker](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/page-template-picker) (not exported)
• [ ] [panel-color-settings](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/panel-color-settings)
• [ ] [preserve-scroll-in-reorder](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/preserve-scroll-in-reorder)
• [x] [preview-options](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/preview-options) -- https://github.com/WordPress/gutenberg/pull/25104 --- @JustinyAhin
• [ ] [skip-to-selected-block](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/skip-to-selected-block)
• [ ] [spacing-panel-control](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/spacing-panel-control) (not exported)
• [ ] [tool-selector](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/tool-selector)
• [ ] [typewriter](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/typewriter)
• [x] [ungroup-button](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/ungroup-button) - https://github.com/WordPress/gutenberg/pull/25142 --- @JustinyAhin (not exported)
• [ ] [unit-control](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/unit-control) - https://github.com/WordPress/gutenberg/pull/25565 --- @ItsJonQ (not exported)
• [ ] [use-display-block-controls](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/use-display-block-controls) (not exported)
• [ ] [use-moving-animation](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/use-moving-animation) (not exported)
• [ ] [use-editor-feature](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/use-editor-feature) --- @itsjonq
• [ ] [use-on-block-drop](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/use-on-block-drop) (not exported)
• [ ] [use-resize-canvas](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/use-resize-canvas) --- @johngodley
• [ ] [use-simulated-media-queries](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/use-simulated-media-query) --- @johngodley
• [ ] [video-player](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/video-player) (not exported)
• [ ] [warning](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/warning) --- @mcsf
• [ ] [writing-flow](https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/writing-flow)