-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Tabs: add docs about not recommending usage with links #68197
Conversation
@WordPress/gutenberg-components do you think that a section in the README is enough? Would you also add some extra docs to Storybook, and in what shape? And finally, what is the plan once we switch to auto-generating the README? Should we have an additional "best practices" Storybook doc, like we're doing with |
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. |
Flaky tests detected in eab9126. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/12432874889
|
I think it's more than enough. Listing all possible ways people can use any component is a hard job, but it's nice we're trying 😅
Using auto-generated docs could be definitely documented as a separate point in the component contribution guidelines. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@WordPress/gutenberg-components do you think that a section in the README is enough? Would you also add some extra docs to Storybook, and in what shape?
And finally, what is the plan once we switch to auto-generating the README? Should we have an additional "best practices" Storybook doc, like we're doing with
Button
?
We might as well do that conversion now: #68209
Feel free to push these content changes into the Best Practices page in that PR. Or you can open a new PR after it lands, if you prefer.
Sounds good! Closing this PR in favour of #68209, to which I pushed a commit adding a "tabs with links" section |
What?
Following the conversation in #67699, this PR introduces a section in the
Tabs
component's README about discouraging the usage of the component with links.Why?
See #67699 (comment)
How?
Added a section to the README
Testing Instructions
Read the added docs