From 7aa831ceac7c01c99ab9567df6281a544121fbee Mon Sep 17 00:00:00 2001 From: jonniebigodes Date: Thu, 30 Nov 2023 16:28:16 +0000 Subject: [PATCH 1/2] Docs: Readme move Storyshots to deprecated status --- Issue.md | 67 ------------------------------------------------------- README.md | 18 +++++++-------- 2 files changed, 9 insertions(+), 76 deletions(-) delete mode 100644 Issue.md diff --git a/Issue.md b/Issue.md deleted file mode 100644 index a56a5a902dc1..000000000000 --- a/Issue.md +++ /dev/null @@ -1,67 +0,0 @@ -*What:* -We want to step our TS game in the monorepo and enable strict typescript in all packages! - -*Why:* -Having TS track for you if a variable might be null or not, enables us to code with much more confidence, -and also gives us quick in editor feedback, when you make assumptions that are not actually true! - -*How:* -We would like to change as little as possible of the actual runtime behavior in this migration. -However, we also don't want to simply silence the compiler everywhere with `!`, `as` or `ts-ignore` to get this migration in. -As a rule of thumb, if the logic is easy enough, prefer improving the code (e.g. add a null check) over silencing the compiler. -If the change needed to do the right thing, is too risky, and not in your expertise, it is okay to silence the compiler. -It is not ideal, but we still gain the benefit that new code written will have extra typesafety. - -Feel free to contribute too any of packages in the list below! - -- [ ] @storybook/addon-backgrounds -- [ ] @storybook/addon-docs -- [ ] @storybook/addon-highlight -- [ ] @storybook/addon-interactions -- [ ] @storybook/addon-jest -- [ ] @storybook/addon-mdx-gfm -- [ ] @storybook/addon-measure -- [ ] @storybook/addon-outline -- [ ] @storybook/addon-storyshots -- [ ] @storybook/addon-storyshots-puppeteer -- [ ] @storybook/addon-storysource -- [ ] @storybook/addon-viewport -- [ ] @storybook/addons -- [ ] @storybook/angular -- [ ] @storybook/api -- [ ] @storybook/blocks -- [ ] @storybook/channel-postmessage -- [ ] @storybook/channel-websocket -- [ ] @storybook/channels -- [ ] @storybook/cli -- [ ] @storybook/client-api -- [ ] @storybook/codemod -- [ ] @storybook/components -- [ ] @storybook/core-client -- [ ] @storybook/core-events -- [ ] @storybook/core-server -- [ ] @storybook/csf-tools -- [ ] @storybook/docs-tools -- [ ] @storybook/external-docs -- [ ] @storybook/html-vite -- [ ] @storybook/instrumenter -- [ ] @storybook/manager -- [ ] @storybook/manager-api -- [ ] @storybook/postinstall -- [ ] @storybook/preact-vite -- [ ] @storybook/preset-create-react-app -- [ ] @storybook/preset-vue-webpack -- [ ] @storybook/preset-vue3-webpack -- [ ] @storybook/react-vite -- [ ] @storybook/router -- [ ] @storybook/scripts -- [ ] @storybook/server -- [ ] @storybook/source-loader -- [ ] @storybook/svelte-vite -- [ ] @storybook/sveltekit -- [ ] @storybook/theming -- [ ] @storybook/types -- [ ] @storybook/vue3-vite -- [ ] @storybook/vue3-webpack5 -- [ ] @storybook/web-components -- [ ] @storybook/web-components-vite diff --git a/README.md b/README.md index 820c663970f0..ff92447befac 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ Storybook comes with a lot of [addons](https://storybook.js.org/docs/react/confi ### Community -For additional help, share your issue in [the repo's GitHub Discussions](https://github.com/storybookjs/storybook/discussions/new?category=help). +For additional help, join us in the [Storybook Discord](https://discord.gg/storybook). ## Projects @@ -131,7 +131,6 @@ For additional help, share your issue in [the repo's GitHub Discussions](https:/ | [measure](code/addons/measure/) | Visually inspect the layout and box model within the Storybook UI | | [outline](code/addons/outline/) | Visually debug the CSS layout and alignment within the Storybook UI | | [query params](https://github.com/storybookjs/addon-queryparams) | Mock query params | -| [storyshots](code/addons/storyshots-core/) | Snapshot testing for components in Storybook | | [storysource](code/addons/storysource/) | View the code of your stories within the Storybook UI | | [viewport](code/addons/viewport/) | Change display sizes and layouts for responsive components using Storybook | @@ -139,13 +138,14 @@ See [Addon / Framework Support Table](https://storybook.js.org/docs/react/api/fr ### Deprecated Addons -| Addons | | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------- | -| [contexts](https://storybook.js.org/addons/@storybook/addon-contexts/) | Addon for driving your components under dynamic contexts | -| [info](https://github.com/storybookjs/deprecated-addons/tree/master/addons/info) | Annotate stories with extra component usage information | -| [knobs](https://github.com/storybookjs/addon-knobs) | Interactively edit component prop data in the Storybook UI | -| [notes](https://github.com/storybookjs/deprecated-addons/tree/master/addons/notes) | Annotate Storybook stories with notes | -| [options](https://www.npmjs.com/package/@storybook/addon-options) | Customize the Storybook UI in code | +| Addons | | +| -------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | +| [contexts](https://storybook.js.org/addons/@storybook/addon-contexts/) | Addon for driving your components under dynamic contexts | +| [info](https://github.com/storybookjs/deprecated-addons/tree/master/addons/info) | Annotate stories with extra component usage information | +| [knobs](https://github.com/storybookjs/addon-knobs) | Interactively edit component prop data in the Storybook UI | +| [notes](https://github.com/storybookjs/deprecated-addons/tree/master/addons/notes) | Annotate Storybook stories with notes | +| [options](https://www.npmjs.com/package/@storybook/addon-options) | Customize the Storybook UI in code | +| [storyshots](https://github.com/storybookjs/storybook/tree/main/code/addons/storyshots-core) | Snapshot testing for components in Storybook | To continue improving your experience, we have to eventually deprecate certain addons in favor of new and better tools. From ef0235fc60e374eaa22a5f4688236a59c1622e5a Mon Sep 17 00:00:00 2001 From: jonniebigodes Date: Thu, 30 Nov 2023 16:34:25 +0000 Subject: [PATCH 2/2] Fixes the community link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ff92447befac..7c174bdcc250 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ Storybook comes with a lot of [addons](https://storybook.js.org/docs/react/confi ### Community -For additional help, join us in the [Storybook Discord](https://discord.gg/storybook). +For additional help, share your issue in [the repo's GitHub Discussions](https://github.com/storybookjs/storybook/discussions/new?category=help). ## Projects