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

FontAppearanceControl: Add README for FontAppearanceControl #68938

Open
wants to merge 3 commits into
base: trunk
Choose a base branch
from

Conversation

SainathPoojary
Copy link
Contributor

@SainathPoojary SainathPoojary commented Jan 29, 2025

Closes: #52051

What?

Adds comprehensive documentation for the FontAppearanceControl component by:

  • Creating a detailed README.md file.
  • Enhancing JSDoc comments with proper syntax, usage examples, and detailed prop descriptions.

Why?

The FontAppearanceControl 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

@shail-mehta shail-mehta added the [Type] Developer Documentation Documentation for developers label Jan 29, 2025
@SainathPoojary SainathPoojary marked this pull request as ready for review January 30, 2025 09:03
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: SainathPoojary <[email protected]>
Co-authored-by: aaronrobertshaw <[email protected]>
Co-authored-by: mburridge <[email protected]>

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add README.md file for font-appearance-control component
2 participants