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

Tabs: add docs about not recommending usage with links #68197

Closed
wants to merge 1 commit into from

Conversation

ciampo
Copy link
Contributor

@ciampo ciampo commented Dec 20, 2024

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

@ciampo ciampo added [Type] Developer Documentation Documentation for developers [Package] Components /packages/components labels Dec 20, 2024
@ciampo ciampo requested a review from a team December 20, 2024 14:10
@ciampo ciampo self-assigned this Dec 20, 2024
@ciampo ciampo requested a review from ajitbohra as a code owner December 20, 2024 14:10
@ciampo
Copy link
Contributor Author

ciampo commented Dec 20, 2024

@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 ?

Copy link

github-actions bot commented Dec 20, 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: ciampo <mciampini@git.wordpress.org>
Co-authored-by: tyxla <tyxla@git.wordpress.org>
Co-authored-by: mirka <0mirka00@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

Flaky tests detected in eab9126.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/12432874889
📝 Reported issues:

@tyxla
Copy link
Member

tyxla commented Dec 20, 2024

@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?

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 😅

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 ?

Using auto-generated docs could be definitely documented as a separate point in the component contribution guidelines.

Copy link
Member

@tyxla tyxla left a comment

Choose a reason for hiding this comment

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

👍

Copy link
Member

@mirka mirka left a 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.

@ciampo
Copy link
Contributor Author

ciampo commented Dec 20, 2024

Sounds good! Closing this PR in favour of #68209, to which I pushed a commit adding a "tabs with links" section

@ciampo ciampo closed this Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Components /packages/components [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants