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

Adds README for inspector-controls-tabs component #69072

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

Conversation

dhruvikpatel18
Copy link
Contributor

Closes: #64791

What?

This PR adds comprehensive README documentation for the inspector-controls-tabs component, which previously lacked usage instructions and documentation.

Why?

The inspector-controls-tabs component is currently missing documentation, making it challenging for developers to understand and implement effectively. This documentation will:

  • Help developers quickly understand the component's purpose and capabilities
  • Provide clear usage examples and best practices
  • Improve the overall developer experience when working with the Gutenberg editor

How?

Added a new README.md file for the inspector-controls-tabs component that includes:

  • Clear component description
  • Installation instructions
  • Basic and advanced usage examples with code snippets
  • Complete props documentation
  • Implementation best practices
  • Related components reference

Testing Instructions

  1. Navigate to the packages/block-editor/src/components/inspector-controls-tabs directory
  2. Verify that the new README.md file exists
  3. Check that the documentation is complete and follows WordPress documentation standards
  4. Verify that the code examples are correct and properly formatted
  5. Test one of the example implementations in a local environment to ensure accuracy

@dhruvikpatel18 dhruvikpatel18 marked this pull request as ready for review February 6, 2025 10:44
Copy link

github-actions bot commented Feb 6, 2025

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core, Gutenberg Plugin.
  • Labels found: .

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

Copy link

github-actions bot commented Feb 6, 2025

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.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @aminul-xs.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

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

Unlinked contributors: aminul-xs.

Co-authored-by: dhruvikpatel18 <[email protected]>

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

@shail-mehta shail-mehta added the [Type] Developer Documentation Documentation for developers label Feb 8, 2025
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.

Missing README and Usage Instructions for inspector-controls-tabs Control
2 participants