Skip to content

Block-Editor Docs: Link to component readme#37975

Merged
gziolo merged 6 commits intoWordPress:trunkfrom
grappler:docs/block-editor
Apr 2, 2022
Merged

Block-Editor Docs: Link to component readme#37975
gziolo merged 6 commits intoWordPress:trunkfrom
grappler:docs/block-editor

Conversation

@grappler
Copy link
Copy Markdown
Member

@grappler grappler commented Jan 14, 2022

Description

Update block editor documentation to include links to the component documentation.

How has this been tested?

Not needed

Types of changes

Document update

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • I've tested my changes with keyboard and screen readers.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR (please manually search all *.native.js files for terms that need renaming or removal).
  • I've updated related schemas if appropriate.

@grappler grappler requested a review from ellatrix as a code owner January 14, 2022 09:22
@grappler grappler changed the title Link to component readme Docs: Block-Editor; Link to component readme Jan 14, 2022
@grappler grappler changed the title Docs: Block-Editor; Link to component readme Block-Editor Docs: Link to component readme Jan 14, 2022
@Mamaduka Mamaduka requested a review from mkaz January 14, 2022 10:03
@skorasaurus skorasaurus added the [Type] Developer Documentation Documentation for developers label Jan 20, 2022
Copy link
Copy Markdown
Member

@skorasaurus skorasaurus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@gziolo
Copy link
Copy Markdown
Member

gziolo commented Apr 1, 2022

This is great. It looks like the updated part of the README file is auto-generated from code comments. It probably would have to be added as code comments in places where those components are exported. Plus you would have to run: npm run docs:build.

@gziolo gziolo added the [Package] Block editor /packages/block-editor label Apr 1, 2022
@grappler grappler force-pushed the docs/block-editor branch from cd234a4 to 881aa0c Compare April 1, 2022 23:23
@grappler
Copy link
Copy Markdown
Member Author

grappler commented Apr 2, 2022

Thanks @gziolo for the tip. I have run npm run docs:build and generated the readme.

@gziolo
Copy link
Copy Markdown
Member

gziolo commented Apr 2, 2022

We are almost there. Linter complains now about the JSDoc comments. This is obviously a special case because we have everything covered in the README. I’m wondering if we could resolve it by defining the component with a function or constant and doing something like:

const MyComponent = () => // code;

/**
 * @see Link
 */
export default MyComponent;

@grappler
Copy link
Copy Markdown
Member Author

grappler commented Apr 2, 2022

I have changed how the exports work. Should be ready now

Copy link
Copy Markdown
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So it worked. Excellent work ❤️

I left one question but it isn’t a blocker.

@gziolo gziolo merged commit 190a207 into WordPress:trunk Apr 2, 2022
@github-actions github-actions bot added this to the Gutenberg 13.0 milestone Apr 2, 2022
@grappler grappler deleted the docs/block-editor branch April 2, 2022 19:06
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