Skip to content

Commit

Permalink
Merge pull request #25963 from storybookjs/docs_stories_of_removal
Browse files Browse the repository at this point in the history
Docs: Remove references to the storiesOf API
  • Loading branch information
jonniebigodes authored Feb 19, 2024
2 parents 1631180 + 5e8fd79 commit 9f0865d
Show file tree
Hide file tree
Showing 6 changed files with 108 additions and 226 deletions.
16 changes: 0 additions & 16 deletions code/lib/preview-api/README-client-api.md

This file was deleted.

1 change: 0 additions & 1 deletion code/lib/preview-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ TODO write proper documentation of this package
This package used to be multiple packages (they have been combined into this one):

- `@storybook/addons` [read (old) docs](./README-addons.md)
- `@storybook/client-api` [read (old) docs](./README-client-api.md)
- `@storybook/core-client` [read (old) docs](./README-core-client.md)
- `@storybook/preview-web` [read (old) docs](./README-preview-web.md)
- `@storybook/store` [read (old) docs](./README-store.md)
97 changes: 0 additions & 97 deletions code/lib/preview-api/docs/storiesOf.md

This file was deleted.

4 changes: 1 addition & 3 deletions docs/api/main-config-indexers.md
Original file line number Diff line number Diff line change
Expand Up @@ -351,9 +351,7 @@ function JsonStoriesPlugin(): PluginOption {

<summary>Generating stories with an alternative API</summary>

You can use a custom indexer and builder plugin to create your own API for defining stories, such as imperatively defining stories similar to the legacy [`storiesOf`](https://github.com/storybookjs/storybook/blob/main/code/lib/preview-api/docs/storiesOf.md) format.

The [dynamic stories proof of concept](https://stackblitz.com/edit/github-h2rgfk?file=README.md) is an elaborate, functional example of doing just that. It contains everything needed to support such a feature, including the indexer, a Vite plugin and a Webpack loader.
You can use a custom indexer and builder plugin to create your API to define stories extending the CSF format. To learn more, see the following [proof of concept](https://stackblitz.com/edit/github-h2rgfk?file=README.md) to set up a custom indexer to generate stories dynamically. It contains everything needed to support such a feature, including the indexer, a Vite plugin, and a Webpack loader.

</details>

Expand Down
10 changes: 5 additions & 5 deletions docs/configure/frameworks-feature-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,8 @@ Community frameworks have fewer contributors which means they may not be as up t

To align the Storybook ecosystem with the current state of frontend development, the following features and addons are now deprecated, no longer maintained, and will be removed in future versions of Storybook

| Feature | Status |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Knobs](https://github.com/storybookjs/addon-knobs) | The Knobs addon was officially deprecated with the release of Storybook 6.3 and is no longer actively maintained. We recommend using the [controls](../essentials/controls.md) instead. |
| [Storyshots](../writing-tests/snapshot-testing.md) | The Storyshots addon was officially deprecated with the release of Storybook 7.6, is no longer actively maintained and was removed in Storybook 8. See the [migration guide](../writing-tests/storyshots-migration-guide.md) for the available alternatives. |
| [`StoriesOf`](https://github.com/storybookjs/storybook/blob/next/code/lib/preview-api/docs/storiesOf.md) | The `storiesOf` API was officially removed with the release of Storybook 8 and is no longer maintained. We recommend using the [CSF API](../api/csf.md) instead for writing stories.<br/>See the [migration guide](../migration-guide.md#storiesof-to-csf) for more information. |
| Feature | Status |
| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Knobs](https://github.com/storybookjs/addon-knobs) | The Knobs addon was officially deprecated with the release of Storybook 6.3 and is no longer actively maintained. We recommend using the [controls](../essentials/controls.md) instead. |
| [Storyshots](../writing-tests/snapshot-testing.md) | The Storyshots addon was officially deprecated with the release of Storybook 7.6, is no longer actively maintained and was removed in Storybook 8. See the [migration guide](../writing-tests/storyshots-migration-guide.md) for the available alternatives. |
| StoriesOf | The `storiesOf` API was officially removed with the release of Storybook 8 and is no longer maintained. We recommend using the [CSF API](../api/csf.md) instead for writing stories.<br/>See the [migration guide](../migration-guide.md#storiesof-to-csf) for more information. |
Loading

0 comments on commit 9f0865d

Please sign in to comment.