Tabs: Auto-generate README

[mirka]

Stacked on #68208

What?

Convert the Tabs README to an auto-generated one.

Supplementary information that was in the existing README is moved to other appropriate locations (JSDocs, Storybook "Best Practices" page).

Why?

To decrease maintenance cost and consolidate the canonical docs for our audience.

Testing Instructions

• In your IDE, check imports of Tabs.Tab for example, and see that the JSDoc includes the subcomponent description.
• npm run docs:components to regenerate READMEs.
• See Storybook docs for Tabs.

[github-actions]

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: mirka <0mirka00@git.wordpress.org>
Co-authored-by: ciampo <mciampini@git.wordpress.org>

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

[mirka]

We should avoid @see tags as they are suppressed in Storybook props tables, and don't make sense when displayed unformatted in the auto-generated README.

[mirka]

The HTML rendering behavior of these "run-on" Markdown lists is not clearly defined, and depending on the renderer can result in a single merged list 😅

@ciampo Any ideas how to address systematically? (I usually just tweak the prop description so it doesn't end in a list item 🙈)

[ciampo]

I'm not sure I fully understand the scenario that you're describing 🙉 Could you explain it again? 🙏

[mirka]

Yes, sorry.

Let's say we have a prop description like this:

/**
 * This is my prop description. It has a list:
 *
 * - Foo
 * - Bar
 * - Baz
 */
myProp?: string;

That is going to end up in the README like this:

### `myProp`

This is my prop description. It does three things:

- Foo
- Bar
- Baz

- Type: `string`
- Required: No

Paste that into a Markdown to HTML converter, and it's going to generate random weird HTML for that ambiguously separated list, depending on the converter implementation. There needs to be some content between those two lists for it to render reliably.

[github-actions]

Flaky tests detected in 4ddf771.
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/12438403211
📝 Reported issues:

• [Flaky Test] Navigates the items list via UP/DOWN arrow keys #64334 in /test/e2e/specs/site-editor/dataviews-list-layout-keyboard.spec.js