Add documentation for the EditorProvider and ExperimentalEditorProvider components #61739
Conversation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @nateinaction! In case you missed it, we'd love to have you join us in our Slack community. If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information. |
github-actions
bot
added
the
First-time Contributor
colorful-tones
added
the
[Type] Developer Documentation
This reverts commit 3f15d73.
colorful-tones
force-pushed
the
update/EditorProvider-docs
branch
from
664a2d0 to
b4a137d
Compare
…er components (WordPress#61739) * Add documentation for the EditorProvider and ExperimentalEditorProvider components * Address ESLint warning react-hooks/exhaustive-deps * Refine EditorProvider editor component JSDocs * Auto-generate EditorProvider editor docs * Revert "Address ESLint warning react-hooks/exhaustive-deps" This reverts commit 3f15d73. --------- Co-authored-by: Damon Cook <[email protected]>
…er components (WordPress#61739) * Add documentation for the EditorProvider and ExperimentalEditorProvider components * Address ESLint warning react-hooks/exhaustive-deps * Refine EditorProvider editor component JSDocs * Auto-generate EditorProvider editor docs * Revert "Address ESLint warning react-hooks/exhaustive-deps" This reverts commit 3f15d73. --------- Co-authored-by: Damon Cook <[email protected]>
What?
Part of: #60358
Added JSDoc to EditorProvider and ExperimentalEditorProvider components and rendered documentation for the readme.
How?
Added JSDocs formatted doc blocks to existing EditorProvider and ExperimentalEditorProvider components.
Ran
npm run docs:buildto render new README.mdRan
npm run lint:js packages/editor/src/components/provider/index.js --fixto ensure we didn't hit any linting errors in CI.