Documentation: Remove subcomponents
feature
#21742
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What I did
This PR removes any mentioning of
subcomponents
from the docs, as it is deprecated in 7.0.The biggest docs page to focus on is https://storybook.js.org/docs/7.0/react/writing-stories/stories-for-multiple-components which starts by mentioning
subcomponents
and then lists a few more powerful alternatives. I've tried to lightly re-write this To only mention the alternatives, but the structure or wording might not be perfect.I hope that @jonniebigodes can move this PR forward and bring it over the finish line.
How to test
Checklist
MIGRATION.MD
Maintainers
make sure to add the
ci:merged
orci:daily
GH label to it.["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]
Deprecation
For future reference, here's a quick summary on the reasoning behing the deprecation:
subcomponents
is deprecated in 7.0. The API is very limiting and hard to improve on. It is somewhat of a half-baked feature, that we want to rethink and do better.Subcomponents has been removed from the default DocsPage in 7.0, but since it's still available in the now deprecated doc block, they can be re-added by defining your own DocsPage globally.
We don't have a clear path forward from this yet, we want to collect feedback from the community about what they want from their subcomponent documentation and how they want to use it, both for docs and for development.