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

Addon-docs: Remove DocsPage slots #10224

Closed
3 tasks
shilman opened this issue Mar 27, 2020 · 1 comment
Closed
3 tasks

Addon-docs: Remove DocsPage slots #10224

shilman opened this issue Mar 27, 2020 · 1 comment

Comments

@shilman
Copy link
Member

shilman commented Mar 27, 2020

In SB5.2, we introduced the concept of DocsPage slots for customizing the DocsPage.

In 5.3, we introduced docs.x story parameters like docs.prepareForInline which get filled in by frameworks and can also be overwritten by users, which is a more natural/convenient way to make global customizations.

We also introduced introduced Custom DocsPage, which makes it possible to add/remove/update DocBlocks on the page.

These two mechanisms are superior to slots, so we should remove slots as a 6.0 breaking change to simplify the code.

For each slot (title, subtitle, description, primary, props, stories):

  • Remove slots
  • Remove documentation
  • Add migration
@shilman
Copy link
Member Author

shilman commented Mar 31, 2020

Ooh-la-la!! I just released https://github.com/storybookjs/storybook/releases/tag/v6.0.0-alpha.30 containing PR #10259 that references this issue. Upgrade today to try it out!

You can find this prerelease on the @next NPM tag.

Closing this issue. Please re-open if you think there's still more to do.

@shilman shilman closed this as completed Mar 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant