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: Add documentation for SpacingSizesControl component #68581

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

Infinite-Null
Copy link
Contributor

Related to: #22891
Closes: #52070

What?

Adds documentation for the SpacingSizesControl component by:

  • Adding a comprehensive README.md file
  • Adding JSDoc comments with proper syntax, examples, and prop descriptions

Why?

The SpacingSizesControl component currently lacks documentation, making it difficult for developers to understand and implement the component correctly:

  • Clear documentation of all available props and their usage
  • Examples showing how to implement the component properly
  • Documentation of component views and internal structure

The documentation follows established patterns from other components while providing specific details relevant to SpacingSizesControl, making it easier for developers to use this component effectively in their blocks.

@Infinite-Null Infinite-Null marked this pull request as ready for review January 10, 2025 05:56
Copy link

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: Infinite-Null <ankitkumarshah@git.wordpress.org>
Co-authored-by: glendaviesnz <glendaviesnz@git.wordpress.org>
Co-authored-by: mburridge <mburridge@git.wordpress.org>

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

@t-hamano t-hamano added [Type] Developer Documentation Documentation for developers [Package] Block editor /packages/block-editor labels Jan 11, 2025
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.

Add README.md file for spacing-sizes-control component
2 participants