From 4be3af226e343ac89560e6a95fcf442c468ae3f4 Mon Sep 17 00:00:00 2001 From: jonniebigodes Date: Fri, 29 Jul 2022 20:38:12 +0100 Subject: [PATCH] Docs broken links fixes --- docs/addons/addon-knowledge-base.md | 2 +- docs/addons/addon-types.md | 4 ++-- docs/addons/writing-presets.md | 2 +- docs/api/new-frameworks.md | 4 ++-- docs/builders/builder-api.md | 4 ++-- docs/configure/babel.md | 2 +- docs/configure/storybook-addons.md | 2 +- docs/contribute/how-to-contribute.md | 2 +- docs/faq.md | 2 +- docs/writing-tests/accessibility-testing.md | 2 +- 10 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/addons/addon-knowledge-base.md b/docs/addons/addon-knowledge-base.md index 86fee5f4899e..fd38290f4ec0 100644 --- a/docs/addons/addon-knowledge-base.md +++ b/docs/addons/addon-knowledge-base.md @@ -75,7 +75,7 @@ Complementing the components, also included is a set of UI primitives. Use the c | Typography | [See implementation](https://github.com/storybookjs/storybook/tree/master/lib/components/src/typography) | [See story](https://5a375b97f4b14f0020b0cda3-wbeulgbetj.chromatic.com/?path=/story/basics-typography--all) |
-The color palette implemented by @storybook/components is a high-level abstraction of the @storybook/theming package. +The color palette implemented by @storybook/components is a high-level abstraction of the @storybook/theming package.
### Build system diff --git a/docs/addons/addon-types.md b/docs/addons/addon-types.md index 6f1a9c462b42..7a7cd0782aff 100644 --- a/docs/addons/addon-types.md +++ b/docs/addons/addon-types.md @@ -10,7 +10,7 @@ UI-based addons allow you to customize Storybook's UI with the following element ### Panels -Panel addons allow you to add your own UI in Storybook's addon panel. This is the most common type of addon in the ecosystem. For example the official [@storybook/actions](../essentials/actions.md) and [@storybook/a11y](https://github.com/storybookjs/storybook/tree/next/addons/a11y) use this pattern. +Panel addons allow you to add your own UI in Storybook's addon panel. This is the most common type of addon in the ecosystem. For example the official [@storybook/actions](../essentials/actions.md) and [@storybook/a11y](https://github.com/storybookjs/storybook/tree/next/code/addons/a11y) use this pattern. ![Storybook panel](./storybook-panel.png) @@ -28,7 +28,7 @@ Use this boilerplate code to add a new `Panel` to Storybook's UI: ### Toolbars -Toolbar addons allow you to add your own custom tools in Storybook's Toolbar. For example the official [@storybook/backgrounds](../essentials/backgrounds.md) and the [storybook-addon-outline](https://github.com/chromaui/storybook-outline) use this pattern. +Toolbar addons allow you to add your own custom tools in Storybook's Toolbar. For example the official [@storybook/backgrounds](../essentials/backgrounds.md) and the [@storybook/addon-outline/](../essentials/measure-and-outline.md#outline-addon) use this pattern. ![Storybook toolbar addon](./storybook-toolbar.png) diff --git a/docs/addons/writing-presets.md b/docs/addons/writing-presets.md index 66a291c048d2..960d2531269a 100644 --- a/docs/addons/writing-presets.md +++ b/docs/addons/writing-presets.md @@ -207,7 +207,7 @@ For example, the following snippet adds a style tag to the preview head programm Similarly, the `managerHead` can be used to modify the surrounding "manager" UI, analogous to `manager-head.html`. -Finally, the preview's main page _template_ can also be overridden using the `previewMainTemplate`, which should return a reference to a file containing an `.ejs` template that gets interpolated with some environment variables. For an example, see the [Storybook's default template](https://github.com/storybookjs/storybook/blob/next/lib/core-common/templates/index.ejs). +Finally, the preview's main page _template_ can also be overridden using the `previewMainTemplate`, which should return a reference to a file containing an `.ejs` template that gets interpolated with some environment variables. For an example, see the [Storybook's default template](https://github.com/storybookjs/storybook/blob/next/code/lib/core-common/templates/preview.ejs). ## Sharing advanced configuration diff --git a/docs/api/new-frameworks.md b/docs/api/new-frameworks.md index b177dae840eb..7e77b0a67d3c 100644 --- a/docs/api/new-frameworks.md +++ b/docs/api/new-frameworks.md @@ -73,7 +73,7 @@ Let’s look at the `@storybook/vue`’s options definition: The value of the `framework` option (i.e., ‘vue’) is something that gets passed to addons and allows them to do specific tasks related to your framework. -The essence of this file is the framework presets, and these are standard [Storybook presets](../addons/writing-presets.md) -- you can look at framework packages in the Storybook monorepo (e.g. [React](https://github.com/storybookjs/storybook/blob/next/app/react/src/server/options.ts), [Vue](https://github.com/storybookjs/storybook/blob/next/app/vue/src/server/options.ts), [Web Components](https://github.com/storybookjs/storybook/blob/next/app/web-components/src/server/options.ts)) to see examples of framework-specific customizations. +The essence of this file is the framework presets, and these are standard [Storybook presets](../addons/writing-presets.md) -- you can look at framework packages in the Storybook monorepo (e.g. [React](https://github.com/storybookjs/storybook/blob/main/app/react/src/server/options.ts), [Vue](https://github.com/storybookjs/storybook/blob/main/app/vue/src/server/options.ts), [Web Components](https://github.com/storybookjs/storybook/blob/main/app/web-components/src/server/options.ts)) to see examples of framework-specific customizations. While developing your custom framework, not maintained by Storybook, you can specify the path to the location file with the `frameworkPath` key: @@ -169,4 +169,4 @@ The globals file typically sets up a single global variable that client-side cod -The `start` function abstracts all of Storybook’s framework-independent client-side (browser) code, and it takes the render function we defined above. For examples of render functions, see [React](https://github.com/storybookjs/storybook/blob/next/app/react/src/client/preview/render.tsx), [Vue](https://github.com/storybookjs/storybook/blob/next/app/vue/src/client/preview/render.ts), [Angular](https://github.com/storybookjs/storybook/blob/next/app/angular/src/client/preview/render.ts), and [Web Components](https://github.com/storybookjs/storybook/blob/next/app/web-components/src/client/preview/render.ts) in the Storybook monorepo. +The `start` function abstracts all of Storybook’s framework-independent client-side (browser) code, and it takes the render function we defined above. For examples of render functions, see [React](https://github.com/storybookjs/storybook/blob/main/app/react/src/client/preview/render.tsx), [Vue](https://github.com/storybookjs/storybook/blob/main/app/vue/src/client/preview/render.ts), [Angular](https://github.com/storybookjs/storybook/blob/main/app/angular/src/client/preview/render.ts), and [Web Components](https://github.com/storybookjs/storybook/blob/main/app/web-components/src/client/preview/render.ts) in the Storybook monorepo. diff --git a/docs/builders/builder-api.md b/docs/builders/builder-api.md index 65e2fbe97501..d21444883388 100644 --- a/docs/builders/builder-api.md +++ b/docs/builders/builder-api.md @@ -35,7 +35,7 @@ To opt into a builder, the user must add it as a dependency and then edit their ## Builder API -In Storybook, every builder must implement the following [API](https://github.com/storybookjs/storybook/blob/next/lib/core-common/src/types.ts#L170-L189), exposing the following configuration options and entry points: +In Storybook, every builder must implement the following [API](https://github.com/storybookjs/storybook/blob/next/code/lib/core-common/src/types.ts#L170-L189), exposing the following configuration options and entry points: @@ -154,7 +154,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/lib/builder-webpack4), [Vite](https://github.com/storybookjs/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, 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/lib/builder-webpack5), [Vite](https://github.com/storybookjs/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. #### Learn more about builders diff --git a/docs/configure/babel.md b/docs/configure/babel.md index 0900aab834f2..c5641689c141 100644 --- a/docs/configure/babel.md +++ b/docs/configure/babel.md @@ -28,7 +28,7 @@ We have added ES2016 support with Babel for transpiling your JS code. In addition to that, we've added a few additional features, like [object spreading](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_syntax) and [`async` `await`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function). -Check out our [source](https://github.com/storybookjs/storybook/blob/next/lib/core-common/src/utils/babel.ts) to learn more about these plugins. +Check out our [source](https://github.com/storybookjs/storybook/blob/main/lib/core-common/src/utils/babel.ts) to learn more about these plugins. ### Custom config file diff --git a/docs/configure/storybook-addons.md b/docs/configure/storybook-addons.md index fbeaacba8bd2..786598a19669 100644 --- a/docs/configure/storybook-addons.md +++ b/docs/configure/storybook-addons.md @@ -21,5 +21,5 @@ Finally, addons can affect the build setup of Storybook by injecting their own w There are many, many Storybook addons, but they can be roughly categorized into three areas: - **Essential** addons are core-team developed addons that are considered a part of the out-of-the-box user experience. These ship by default with new Storybook installations. -- **Core** addons are developed by the core team. They are kept in sync with the development of Storybook itself and written in idiomatic ways as templates for other addons. They can be found within the [Storybook monorepo](https://github.com/storybookjs/storybook/tree/next/addons). +- **Core** addons are developed by the core team. They are kept in sync with the development of Storybook itself and written in idiomatic ways as templates for other addons. They can be found within the [Storybook monorepo](https://github.com/storybookjs/storybook/tree/next/code/addons). - **Community** addons are addons written by the massive Storybook community. They can be found on our [website](https://storybook.js.org/addons/), [GitHub](https://github.com/), and [npm](https://www.npmjs.com/). diff --git a/docs/contribute/how-to-contribute.md b/docs/contribute/how-to-contribute.md index 894cb309f598..198f7f978d0a 100644 --- a/docs/contribute/how-to-contribute.md +++ b/docs/contribute/how-to-contribute.md @@ -14,7 +14,7 @@ In the interest of fostering an open and welcoming environment, we as contributo - [**Docs**](./documentation-updates.md): Typos, clarifications - [**Integrations**](./../api/new-frameworks.md): Integrate Storybook with your favorite library - [**Addons**](./../addons/introduction.md): Build an addon and share it with the community -- [**Examples**](https://github.com/storybookjs/storybook/tree/next/examples/official-storybook): Add an example/test for a feature +- [**Examples**](https://github.com/storybookjs/storybook/tree/next/code/examples/official-storybook): Add an example/test for a feature ## Not sure how to get started? diff --git a/docs/faq.md b/docs/faq.md index 45034b031d80..fe91b55ce3f2 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -215,7 +215,7 @@ We're only covering versions 5.3 and 5.0 as they were important milestones for S | | Addons API | [See current documentation](./addons/addons-api.md) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/addons/api) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/addons/api) | | API | Stories/Component Story Format | [See current documentation](./api/csf.md) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/formats/component-story-format) | Non existing feature or undocumented | | | Stories/MDX syntax | [See current documentation](./api/mdx.md) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/formats/mdx-syntax) | Non existing feature or undocumented | -| | Stories/StoriesOF format (see note below) | [See current documentation](https://github.com/storybookjs/storybook/blob/next/lib/core/docs/storiesOf.md) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/formats/storiesof-api) | Non existing feature or undocumented | +| | Stories/StoriesOF format (see note below) | [See current documentation](https://github.com/storybookjs/storybook/blob/main/lib/core/docs/storiesOf.md) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/formats/storiesof-api) | Non existing feature or undocumented | | | Frameworks | [See current documentation](./api/new-frameworks.md) | Non existing feature or undocumented | Non existing feature or undocumented | | | CLI options | [See current documentation](./api/cli-options.md) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/configurations/cli-options) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/configurations/cli-options) | diff --git a/docs/writing-tests/accessibility-testing.md b/docs/writing-tests/accessibility-testing.md index 2e0c846935c9..7a86ddc5e86e 100644 --- a/docs/writing-tests/accessibility-testing.md +++ b/docs/writing-tests/accessibility-testing.md @@ -81,7 +81,7 @@ Cycling through both stories, you will see that the `Inaccessible` story contain ### Configure -Out of the box, Storybook's accessibility addon includes a set of accessibility rules that cover most issues. You can also fine-tune the [addon configuration](https://github.com/storybookjs/storybook/tree/next/addons/a11y#parameters) or override [Axe's ruleset](https://github.com/storybookjs/storybook/tree/next/addons/a11y#handling-failing-rules) to best suit your needs. +Out of the box, Storybook's accessibility addon includes a set of accessibility rules that cover most issues. You can also fine-tune the [addon configuration](https://github.com/storybookjs/storybook/tree/next/code/addons/a11y#parameters) or override [Axe's ruleset](https://github.com/storybookjs/storybook/tree/next/code/addons/a11y#handling-failing-rules) to best suit your needs. #### Global a11y configuration