Tabs: Auto-generate README #68209
Tabs: Auto-generate README #68209
Conversation
mirka
added
[Type] Developer Documentation
|
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. |
| * for more info. | ||
| * | ||
| * @default true | ||
| * | ||
| * @see https://www.w3.org/WAI/ARIA/apg/patterns/tabpanel/ |
There was a problem hiding this comment.
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.
|
Flaky tests detected in 31a04e1. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/12519111570
|
Co-authored-by: Marin Atanasov <[email protected]>
Co-authored-by: Marco Ciampini <[email protected]>
# Conflicts: # bin/api-docs/gen-components-docs/markdown/index.mjs
| @@ -105,7 +105,6 @@ export type TabListProps = { | |||
| }; | |||
|
|
|||
| // TODO: consider prop name changes (tabId, selectedTabId) | |||
| // switch to auto-generated README | |||
| // compound technique | |||
There was a problem hiding this comment.
@ciampo Not sure if these TODOs were even meant to be committed 😂 Do you want me to remove the rest, too?
* Components: Normalize newlines * Tabs: Auto-generate README * Remove redundant JSDocs * Add "Using `Tabs` with links" section * Tweak wording Co-authored-by: Marin Atanasov <[email protected]> * Tweak wording Co-authored-by: Marco Ciampini <[email protected]> * Fix typo * Regenerate readme * Fix lists * Convert code snippets back to tab indentation * Update readme * Remove todo item --------- Co-authored-by: mirka <[email protected]> Co-authored-by: ciampo <[email protected]> Co-authored-by: tyxla <[email protected]>
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
Tabs.Tabfor example, and see that the JSDoc includes the subcomponent description.npm run docs:componentsto regenerate READMEs.