WordPress / gutenberg

The Block Editor project for WordPress and beyond. Plugin is available from the official repository.
https://wordpress.org/gutenberg/
Other
10.34k stars 4.13k forks source link

Surface Sub-component Readmes in Handbook Documentation #15107

Open mkaz opened 5 years ago

mkaz commented 5 years ago

Numerous sub-components have readme and documentation created, but these are not surfaced in the Gutenberg Handbook, and thus can not easily be linked to.

One example is InnerBlocks, the component documentation is here: https://github.com/WordPress/gutenberg/tree/master/packages/block-editor/src/components/inner-blocks

But the Gutenberg Handbook documentation for Block Editor shows as it is undocumented here: https://wordpress.org/gutenberg/handbook/designers-developers/developers/packages/packages-block-editor/

Which also means we can't link to it from places like here, which tries but is a broken link https://wordpress.org/gutenberg/handbook/designers-developers/developers/block-api/block-templates/

aduth commented 5 years ago

Considering action steps here:

bph commented 9 months ago

Now that the Developer Resources redesign has been put into production, this would be the next step to provide a complete and comprehensive documentation for developers.