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

Add documentation for the EditorProvider and ExperimentalEditorProvider components #61739

Merged

Conversation

nateinaction
Copy link
Contributor

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:build to render new README.md
Ran npm run lint:js packages/editor/src/components/provider/index.js --fix to ensure we didn't hit any linting errors in CI.

Copy link

github-actions bot commented May 16, 2024

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 props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: nateinaction <nateinaction@git.wordpress.org>
Co-authored-by: colorful-tones <colorful-tones@git.wordpress.org>
Co-authored-by: ntsekouras <ntsekouras@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link

👋 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 github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label May 16, 2024
@colorful-tones colorful-tones self-assigned this May 17, 2024
@colorful-tones colorful-tones added the [Type] Developer Documentation Documentation for developers label May 17, 2024
Copy link
Contributor

@ntsekouras ntsekouras left a comment

Choose a reason for hiding this comment

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

Thank you!

@colorful-tones colorful-tones merged commit eb2b8a5 into WordPress:trunk May 31, 2024
62 checks passed
@github-actions github-actions bot added this to the Gutenberg 18.5 milestone May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants