Block-Editor Docs: Link to component readme#37975
Conversation
|
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: |
cd234a4 to
881aa0c
Compare
|
Thanks @gziolo for the tip. I have run |
|
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; |
|
I have changed how the exports work. Should be ready now |
gziolo
left a comment
There was a problem hiding this comment.
So it worked. Excellent work ❤️
I left one question but it isn’t a blocker.
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:
*.native.jsfiles for terms that need renaming or removal).