diff --git a/code/addons/controls/README.md b/code/addons/controls/README.md index 0622e23a302c..1d3a8ae3797b 100644 --- a/code/addons/controls/README.md +++ b/code/addons/controls/README.md @@ -44,7 +44,7 @@ Addon-knobs is one of Storybook's most popular addons with over 1M weekly downlo Therefore, rather than deprecating addon-knobs immediately, we will continue to release knobs with the Storybook core distribution until 7.0. This will give us time to improve Controls based on user feedback, and also give knobs users ample time to migrate. -If you are somehow tied to knobs or prefer the knobs interface, we are happy to take on maintainers for the knobs project. If this interests you, hop on our [Discord](https://discord.gg/storybook). +If you are somehow tied to knobs or prefer the knobs interface, we are happy to take on maintainers for the knobs project. If this interests you, please get in touch with us in the [`#contributing`](https://discord.com/channels/486522875931656193/839297503446695956) Discord channel. ### How do I migrate from addon-knobs? diff --git a/docs/addons/addon-migration-guide.md b/docs/addons/addon-migration-guide.md index 8a7bd08c7470..b4547353b98f 100644 --- a/docs/addons/addon-migration-guide.md +++ b/docs/addons/addon-migration-guide.md @@ -75,4 +75,4 @@ We also recommend releasing your own addon using the `next` tag to test it out i ## Support -If you’ve followed this guide and your addon is still not working, please reach out on the [Storybook Discord](https://discord.gg/storybook) in the `#addons` channel and we’ll help you get to the bottom of it and upgrade the guide accordingly. +If you're still having issues with your addon after following this guide, please open a [new discussion](https://github.com/storybookjs/storybook/discussions/new?category=help) in our GitHub repository. diff --git a/docs/addons/integration-catalog.md b/docs/addons/integration-catalog.md index cdf96459eb75..fba4fd76fe2f 100644 --- a/docs/addons/integration-catalog.md +++ b/docs/addons/integration-catalog.md @@ -102,7 +102,7 @@ Not finding the recipe that you want? If it's popular in the community, our docs ### Request a recipe -If you'd like to request a recipe, head over to the [#maintenance channel](https://discord.com/channels/486522875931656193/490070912448724992) of our community Discord and ask. +If you'd like to request a recipe, open a [new discussion](https://github.com/storybookjs/storybook/discussions/new?category=ideas) in our GitHub repo. We'll review your request, and if it's popular, we'll add it to our backlog and prioritize it. ## Learn more about the Storybook addon ecosystem diff --git a/docs/builders/builder-api.md b/docs/builders/builder-api.md index 5d21370b5100..82ecfcf27fbf 100644 --- a/docs/builders/builder-api.md +++ b/docs/builders/builder-api.md @@ -155,7 +155,7 @@ While running in development mode, the builder's development server must be able ### More information -This area is under rapid development, so the documented is still in progress and subject to change. If you are interested in writing your builder, we encourage you to check [webpack](https://github.com/storybookjs/storybook/tree/next/code/builders/builder-webpack5), [Vite](https://github.com/storybookjs/storybook/tree/next/code/builders/builder-vite), and Modern Web's [dev-server-storybook](https://github.com/modernweb-dev/web/blob/master/packages/dev-server-storybook/src/serve/storybookPlugin.ts) source code. In addition, we have a wonderful contributor community on [Storybook Discord](https://discord.gg/storybook) if you have questions. Ping us in the [#contributing](https://discord.com/channels/486522875931656193/839297503446695956) channel. +This area is under rapid development, and the associated documentation is still in progress and subject to change. If you are interested in creating a builder, you can learn more about implementing a builder in Storybook by checking the source code for [Vite](https://github.com/storybookjs/storybook/tree/next/code/builders/builder-vite), [Webpack](https://github.com/storybookjs/storybook/tree/next/code/builders/builder-webpack5), or Modern Web's [dev-server-storybook](https://github.com/modernweb-dev/web/blob/master/packages/dev-server-storybook/src/serve/storybookPlugin.ts). When you're ready, open an [RFC](../contribute/RFC.md) to discuss your proposal with the Storybook community and maintainers. #### Learn more about builders diff --git a/docs/configure/frameworks.md b/docs/configure/frameworks.md index 3602138dab30..8efe4b5dac8c 100644 --- a/docs/configure/frameworks.md +++ b/docs/configure/frameworks.md @@ -64,7 +64,7 @@ Storybook is a framework-agnostic tool. It can be used with any framework. Howev ### Legacy framework support -We're deprecating support for several frameworks, including [Aurelia](https://github.com/aurelia/framework), [Marionette](https://github.com/marionettejs/backbone.marionette), [Mithril](https://github.com/MithrilJS/mithril.js), [Rax](https://github.com/alibaba/rax), and [Riot](https://github.com/riot/riot). Nevertheless, we're always looking for help maintaining these frameworks. If you're working with one of them and you want to continue supporting them, visit the dedicated [Storybook End-of-Life repository](https://github.com/storybook-eol) to learn more about the sunsetting process and for instructions on how to contribute visit our [Discord server](https://discord.gg/storybook). +We're deprecating support for several frameworks, including [Aurelia](https://github.com/aurelia/framework), [Marionette](https://github.com/marionettejs/backbone.marionette), [Mithril](https://github.com/MithrilJS/mithril.js), [Rax](https://github.com/alibaba/rax), and [Riot](https://github.com/riot/riot). Nevertheless, we're always looking for help maintaining these frameworks. If you're working with one of them and you want to continue supporting them, visit the dedicated [Storybook End-of-Life repository](https://github.com/storybook-eol). To learn more about the sunsetting process and view instructions on how to contribute, read our [documentation](../contribute/index.md). ### Learn about configuring Storybook diff --git a/docs/configure/typescript.md b/docs/configure/typescript.md index dbe0453e399c..b9aba6763119 100644 --- a/docs/configure/typescript.md +++ b/docs/configure/typescript.md @@ -90,7 +90,7 @@ Now, when you define a story or update an existing one, you'll automatically get ### The `satisfies` operator is not working as expected -Out of the box, Storybook supports the `satisfies` operator for almost every framework already using TypeScript version 4.9 or higher. However, due to the constraints of the Angular and Web Components framework, you might run into issues when applying this operator for additional type safety. This is primarily due to how both frameworks are currently implemented, making it almost impossible for Storybook to determine if the component property is required. If you encounter this issue, we recommend reaching out to the maintainers using the default communication channels (e.g., [Discord server](https://discord.com/channels/486522875931656193/570426522528382976), [GitHub discussion](https://github.com/storybookjs/storybook/discussions/20988)). +Out of the box, Storybook supports the `satisfies` operator for almost every framework already using TypeScript version 4.9 or higher. However, due to the constraints of the Angular and Web Components framework, you might run into issues when applying this operator for additional type safety. This is primarily due to how both frameworks are currently implemented, making it almost impossible for Storybook to determine if the component property is required. If you encounter this issue, please open up a support request on [GitHub Discussions](https://github.com/storybookjs/storybook/discussions/new?category=help). ### The TypeScript auto-completion is not working on my editor diff --git a/docs/contribute/framework.md b/docs/contribute/framework.md index a29ab99abc3b..27fdf03b70af 100644 --- a/docs/contribute/framework.md +++ b/docs/contribute/framework.md @@ -142,7 +142,7 @@ Test it in a fresh project using a Storybook set up as close as possible to your ### 6. Let us know! -Once it's fully tested and released, please let us know about your framework by either announcing it in the `#showcase` channel of the [Storybook Discord](https://discord.gg/storybook) or tweeting it and mentioning `@storybookjs`. It's our hope that well-made community frameworks can eventually move into the Storybook codebase and be considered "officially" supported. +Once it's fully tested and released, please let us know about your framework by either announcing it in the [`#showcase`](https://discord.com/channels/486522875931656193/1048740936953376859) Discord channel or tweeting it and mentioning `@storybookjs`. It's our hope that well-made community frameworks can eventually move into the Storybook codebase and be considered "officially" supported. ## Learn more about contributing to Storybook diff --git a/docs/contribute/index.md b/docs/contribute/index.md index a49fbeb2fc1a..db49e426fa17 100644 --- a/docs/contribute/index.md +++ b/docs/contribute/index.md @@ -20,6 +20,6 @@ In the interest of fostering an open and welcoming environment, we as contributo ## Not sure how to get started? -- [Chat in Discord #contributing](https://discord.gg/storybook) +- [Chat in Discord `#contributing`](https://discord.com/channels/486522875931656193/839297503446695956) - [Browse "good first issues" to fix](https://github.com/storybookjs/storybook/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) - [Submit a bug report or feature request](https://github.com/storybookjs/storybook/issues) diff --git a/docs/migration-guide.md b/docs/migration-guide.md index 6f075c9904f2..e0cf30691b06 100644 --- a/docs/migration-guide.md +++ b/docs/migration-guide.md @@ -145,7 +145,6 @@ The automatic upgrade should get your Storybook into a working state. If you enc 2. Check [the full migration notes](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#from-version-65x-to-700), which contains an exhaustive list of noteworthy changes in Storybook 7. Many of these are already handled by automigrations when you upgrade, but not all are. It’s also possible that you’re experiencing a corner case that we’re not aware of. 3. Search [Storybook issues on GitHub](https://github.com/storybookjs/storybook/issues). If you’re seeing a problem, there’s a good chance other people are too. If so, upvote the issue, try out any workarounds described in the comments, and comment back if you have useful info to contribute. 4. If there’s no existing issue, you can [file one](https://github.com/storybookjs/storybook/issues/new/choose), ideally with a reproduction attached. We’ll be on top of Storybook 7 issues as we’re stabilizing the release. -5. If you prefer a more interactive medium, try out the `#prerelease` forum in the [Storybook Discord](https://discord.gg/storybook). We have Storybook maintainers and a large community of users who should be able to give you a hand. If you prefer to debug yourself, here are a few useful things you can do to help narrow down the problem: diff --git a/docs/snippets/common/main-config-swc-jsx-transform.ts.mdx b/docs/snippets/common/main-config-swc-jsx-transform.ts.mdx index eb0e44fc27ff..aadc09cd4a2e 100644 --- a/docs/snippets/common/main-config-swc-jsx-transform.ts.mdx +++ b/docs/snippets/common/main-config-swc-jsx-transform.ts.mdx @@ -1,4 +1,6 @@ ```ts +// .storybook/main.ts + // Replace your-framework with the webpack-based framework you are using (e.g., react-webpack5) import type { StorybookConfig } from '@storybook/your-framework'; diff --git a/docs/snippets/common/test-runner-snapshot.js.mdx b/docs/snippets/common/test-runner-snapshot.js.mdx deleted file mode 100644 index d62224bc0989..000000000000 --- a/docs/snippets/common/test-runner-snapshot.js.mdx +++ /dev/null @@ -1,12 +0,0 @@ -```js -// .storybook/test-runner.js - -export default { - async postRender(page, context) { - // the #storybook-root element wraps each story - const elementHandler = await page.$('#storybook-root'); - const innerHTML = await elementHandler.innerHTML(); - expect(innerHTML).toMatchSnapshot(); - }, -}; -``` diff --git a/docs/snippets/common/test-runner-snapshot.ts.mdx b/docs/snippets/common/test-runner-snapshot.ts.mdx deleted file mode 100644 index 1874d5d9fe27..000000000000 --- a/docs/snippets/common/test-runner-snapshot.ts.mdx +++ /dev/null @@ -1,16 +0,0 @@ -```ts -// .storybook/test-runner.ts - -import type { TestRunnerConfig } from '@storybook/test-runner'; - -const config: TestRunnerConfig = { - async postRender(page, context) { - // the #storybook-root element wraps each story - const elementHandler = await page.$('#storybook-root'); - const innerHTML = await elementHandler.innerHTML(); - expect(innerHTML).toMatchSnapshot(); - }, -}; - -export default config; -``` diff --git a/docs/writing-docs/autodocs.md b/docs/writing-docs/autodocs.md index bbf0e0d3e7d6..427db5c7e79b 100644 --- a/docs/writing-docs/autodocs.md +++ b/docs/writing-docs/autodocs.md @@ -237,7 +237,7 @@ This is not a Storybook issue but a breaking change introduced with MDX 2. For m ### The table of contents doesn't render as expected -When using Autodocs's table of contents, you may encounter situations where it appears differently than expected. To help you resolve these problems, we have compiled a list of possible scenarios that may cause issues. If you've run into any of the items listed below and you're interested in helping us improve the support for this feature, we encourage you to reach out to the maintainers using the default communication channels (e.g., [Discord server](https://discord.com/channels/486522875931656193/570426522528382976), [GitHub issues](https://github.com/storybookjs/storybook/issues)). +When using Autodocs's table of contents, you may encounter situations where it appears differently than expected. To help you resolve these problems, we have compiled a list of possible scenarios that may cause issues. #### With simple documentation pages @@ -283,7 +283,7 @@ Additionally, if you're developing using TypeScript, you may need to update Stor -If you're still encountering issues, we recommend reaching out to the maintainers using the default communication channels (e.g., [Discord server](https://discord.com/channels/486522875931656193/570426522528382976), [GitHub issues](https://github.com/storybookjs/storybook/issues)). +If you're still encountering issues, we recommend reaching out to the community using the default communication channels (e.g., [GitHub discussions](https://github.com/storybookjs/storybook/discussions/new?category=help)). #### Learn more about Storybook documentation diff --git a/docs/writing-docs/mdx.md b/docs/writing-docs/mdx.md index f6641482236c..bd31e66374a0 100644 --- a/docs/writing-docs/mdx.md +++ b/docs/writing-docs/mdx.md @@ -208,7 +208,7 @@ The [`remark-gfm`](https://github.com/remarkjs/remark-gfm) package isn't provide ### Automigration -To help you transition to the new version, we've created a migration helper in our CLI. We recommend using it and reaching out to the maintainers using the default communication channels (e.g., [Discord server](https://discord.com/channels/486522875931656193/570426522528382976), [GitHub issues](https://github.com/storybookjs/storybook/issues)) for problems you encounter. +To help you transition to the new version, we've created a migration helper in our CLI. We recommend using it and reaching out using the default communication channels (e.g., [GitHub discussions](https://github.com/storybookjs/storybook/discussions/new?category=help)) for problems you encounter. ```shell npx storybook@latest automigrate mdx1to2 @@ -453,7 +453,7 @@ Additionally, if you're working with VSCode, you can add the [MDX extension](htt } ``` -If you're still encountering issues, we recommend reaching out to the maintainers using the default communication channels (e.g., [Discord server](https://discord.com/channels/486522875931656193/570426522528382976), [GitHub issues](https://github.com/storybookjs/storybook/issues)). +If you're still encountering issues, we recommend reaching out to the community using the default communication channels (e.g., [GitHub discussions](https://github.com/storybookjs/storybook/discussions/new?category=help)). #### Learn more about Storybook documentation