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

Documentation: Remove subcomponents feature #21742

Merged
merged 1 commit into from
Mar 23, 2023
Merged

Conversation

JReinhold
Copy link
Contributor

@JReinhold JReinhold commented Mar 22, 2023

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

  • Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Maintainers

  • If this PR should be tested against many or all sandboxes,
    make sure to add the ci:merged or ci:daily GH label to it.
  • Make sure this PR contains one of the labels below.

["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.

@JReinhold JReinhold marked this pull request as ready for review March 22, 2023 20:59
@JReinhold JReinhold merged commit 8e10da0 into next Mar 23, 2023
@JReinhold JReinhold deleted the remove-subcomponents-docs branch March 23, 2023 15:10
kylegach added a commit that referenced this pull request Jan 29, 2024
- Largely reverted relevant portions of #20233 & #21742
@kylegach kylegach mentioned this pull request Jan 29, 2024
4 tasks
kylegach added a commit that referenced this pull request Jan 30, 2024
- Largely reverted relevant portions of #20233 & #21742
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants