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

Block Editor: Docs: Add DocBlock see references to component READMEs #15194

Merged
merged 1 commit into from
Apr 26, 2019

Conversation

aduth
Copy link
Member

@aduth aduth commented Apr 25, 2019

Previously: #14227 (comment)
Partially addresses: #15107

This pull request seeks to add a minimal JSDoc for the autogenerated documentation of block editor components where there is a corresponding README.md file which could provide additional usage information.

Implementation notes:

Discovered relevant README files to include via:

find packages/block-editor -name 'README.md'

Testing instructions:

Verify there are no changes after running npm run docs:build.

Verify all links are valid.

@oandregal oandregal merged commit ffd2f7b into master Apr 26, 2019
@oandregal oandregal deleted the update/block-editor-components-readme-references branch April 26, 2019 07:01
@youknowriad youknowriad added this to the 5.6 (Gutenberg) milestone May 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Block editor /packages/block-editor [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants