diff --git a/docs/api/arg-types.mdx b/docs/api/arg-types.mdx index 71fc66d403ad..b819cd0fa218 100644 --- a/docs/api/arg-types.mdx +++ b/docs/api/arg-types.mdx @@ -1,5 +1,8 @@ --- title: 'ArgTypes' +sidebar: + order: 3 + title: ArgTypes --- ArgTypes specify the behavior of [args](../writing-stories/args.md). By specifying the type of an arg, you constrain the values that it can accept and provide information about args that are not explicitly set (i.e., [description](#description)). diff --git a/docs/api/cli-options.mdx b/docs/api/cli-options.mdx index 392c5f0ef99a..0720aecbe603 100644 --- a/docs/api/cli-options.mdx +++ b/docs/api/cli-options.mdx @@ -1,6 +1,9 @@ --- title: 'CLI options' hideRendererSelector: true +sidebar: + order: 7 + title: CLI options --- The Storybook command line interface (CLI) is the main tool you use to build and develop Storybook. diff --git a/docs/api/csf.mdx b/docs/api/csf.mdx index b2e7ec505bc5..5091ce1f532d 100644 --- a/docs/api/csf.mdx +++ b/docs/api/csf.mdx @@ -1,5 +1,8 @@ --- title: 'Component Story Format (CSF)' +sidebar: + order: 2 + title: Component Story Format (CSF) --- diff --git a/docs/api/doc-block-argtypes.mdx b/docs/api/doc-blocks/doc-block-argtypes.mdx similarity index 100% rename from docs/api/doc-block-argtypes.mdx rename to docs/api/doc-blocks/doc-block-argtypes.mdx diff --git a/docs/api/doc-block-canvas.mdx b/docs/api/doc-blocks/doc-block-canvas.mdx similarity index 100% rename from docs/api/doc-block-canvas.mdx rename to docs/api/doc-blocks/doc-block-canvas.mdx diff --git a/docs/api/doc-block-colorpalette.mdx b/docs/api/doc-blocks/doc-block-colorpalette.mdx similarity index 100% rename from docs/api/doc-block-colorpalette.mdx rename to docs/api/doc-blocks/doc-block-colorpalette.mdx diff --git a/docs/api/doc-block-controls.mdx b/docs/api/doc-blocks/doc-block-controls.mdx similarity index 100% rename from docs/api/doc-block-controls.mdx rename to docs/api/doc-blocks/doc-block-controls.mdx diff --git a/docs/api/doc-block-description.mdx b/docs/api/doc-blocks/doc-block-description.mdx similarity index 100% rename from docs/api/doc-block-description.mdx rename to docs/api/doc-blocks/doc-block-description.mdx diff --git a/docs/api/doc-block-icongallery.mdx b/docs/api/doc-blocks/doc-block-icongallery.mdx similarity index 100% rename from docs/api/doc-block-icongallery.mdx rename to docs/api/doc-blocks/doc-block-icongallery.mdx diff --git a/docs/api/doc-block-markdown.mdx b/docs/api/doc-blocks/doc-block-markdown.mdx similarity index 100% rename from docs/api/doc-block-markdown.mdx rename to docs/api/doc-blocks/doc-block-markdown.mdx diff --git a/docs/api/doc-block-meta.mdx b/docs/api/doc-blocks/doc-block-meta.mdx similarity index 100% rename from docs/api/doc-block-meta.mdx rename to docs/api/doc-blocks/doc-block-meta.mdx diff --git a/docs/api/doc-block-primary.mdx b/docs/api/doc-blocks/doc-block-primary.mdx similarity index 100% rename from docs/api/doc-block-primary.mdx rename to docs/api/doc-blocks/doc-block-primary.mdx diff --git a/docs/api/doc-block-source.mdx b/docs/api/doc-blocks/doc-block-source.mdx similarity index 100% rename from docs/api/doc-block-source.mdx rename to docs/api/doc-blocks/doc-block-source.mdx diff --git a/docs/api/doc-block-stories.mdx b/docs/api/doc-blocks/doc-block-stories.mdx similarity index 100% rename from docs/api/doc-block-stories.mdx rename to docs/api/doc-blocks/doc-block-stories.mdx diff --git a/docs/api/doc-block-story.mdx b/docs/api/doc-blocks/doc-block-story.mdx similarity index 100% rename from docs/api/doc-block-story.mdx rename to docs/api/doc-blocks/doc-block-story.mdx diff --git a/docs/api/doc-block-subtitle.mdx b/docs/api/doc-blocks/doc-block-subtitle.mdx similarity index 100% rename from docs/api/doc-block-subtitle.mdx rename to docs/api/doc-blocks/doc-block-subtitle.mdx diff --git a/docs/api/doc-block-title.mdx b/docs/api/doc-blocks/doc-block-title.mdx similarity index 100% rename from docs/api/doc-block-title.mdx rename to docs/api/doc-blocks/doc-block-title.mdx diff --git a/docs/api/doc-block-typeset.mdx b/docs/api/doc-blocks/doc-block-typeset.mdx similarity index 100% rename from docs/api/doc-block-typeset.mdx rename to docs/api/doc-blocks/doc-block-typeset.mdx diff --git a/docs/api/doc-block-unstyled.mdx b/docs/api/doc-blocks/doc-block-unstyled.mdx similarity index 100% rename from docs/api/doc-block-unstyled.mdx rename to docs/api/doc-blocks/doc-block-unstyled.mdx diff --git a/docs/api/doc-block-useof.mdx b/docs/api/doc-blocks/doc-block-useof.mdx similarity index 100% rename from docs/api/doc-block-useof.mdx rename to docs/api/doc-blocks/doc-block-useof.mdx diff --git a/docs/api/doc-blocks/index.mdx b/docs/api/doc-blocks/index.mdx new file mode 100644 index 000000000000..d71c4eb2a286 --- /dev/null +++ b/docs/api/doc-blocks/index.mdx @@ -0,0 +1,6 @@ +--- +title: Doc Blocks +sidebar: + order: 5 + title: Doc Blocks +--- \ No newline at end of file diff --git a/docs/api/main.js configuration/index.mdx b/docs/api/main.js configuration/index.mdx new file mode 100644 index 000000000000..18d625a5de5f --- /dev/null +++ b/docs/api/main.js configuration/index.mdx @@ -0,0 +1,6 @@ +--- +title: 'main.js|ts configuration' +sidebar: + order: 1 + title: main.js|ts configuration +--- \ No newline at end of file diff --git a/docs/api/main-config-addons.mdx b/docs/api/main.js configuration/main-config-addons.mdx similarity index 100% rename from docs/api/main-config-addons.mdx rename to docs/api/main.js configuration/main-config-addons.mdx diff --git a/docs/api/main-config-babel-default.mdx b/docs/api/main.js configuration/main-config-babel-default.mdx similarity index 100% rename from docs/api/main-config-babel-default.mdx rename to docs/api/main.js configuration/main-config-babel-default.mdx diff --git a/docs/api/main-config-babel.mdx b/docs/api/main.js configuration/main-config-babel.mdx similarity index 100% rename from docs/api/main-config-babel.mdx rename to docs/api/main.js configuration/main-config-babel.mdx diff --git a/docs/api/main-config-build.mdx b/docs/api/main.js configuration/main-config-build.mdx similarity index 100% rename from docs/api/main-config-build.mdx rename to docs/api/main.js configuration/main-config-build.mdx diff --git a/docs/api/main-config-core.mdx b/docs/api/main.js configuration/main-config-core.mdx similarity index 100% rename from docs/api/main-config-core.mdx rename to docs/api/main.js configuration/main-config-core.mdx diff --git a/docs/api/main-config-docs.mdx b/docs/api/main.js configuration/main-config-docs.mdx similarity index 100% rename from docs/api/main-config-docs.mdx rename to docs/api/main.js configuration/main-config-docs.mdx diff --git a/docs/api/main-config-env.mdx b/docs/api/main.js configuration/main-config-env.mdx similarity index 100% rename from docs/api/main-config-env.mdx rename to docs/api/main.js configuration/main-config-env.mdx diff --git a/docs/api/main-config-features.mdx b/docs/api/main.js configuration/main-config-features.mdx similarity index 100% rename from docs/api/main-config-features.mdx rename to docs/api/main.js configuration/main-config-features.mdx diff --git a/docs/api/main-config-framework.mdx b/docs/api/main.js configuration/main-config-framework.mdx similarity index 100% rename from docs/api/main-config-framework.mdx rename to docs/api/main.js configuration/main-config-framework.mdx diff --git a/docs/api/main-config-indexers.mdx b/docs/api/main.js configuration/main-config-indexers.mdx similarity index 100% rename from docs/api/main-config-indexers.mdx rename to docs/api/main.js configuration/main-config-indexers.mdx diff --git a/docs/api/main-config-log-level.mdx b/docs/api/main.js configuration/main-config-log-level.mdx similarity index 100% rename from docs/api/main-config-log-level.mdx rename to docs/api/main.js configuration/main-config-log-level.mdx diff --git a/docs/api/main-config-manager-head.mdx b/docs/api/main.js configuration/main-config-manager-head.mdx similarity index 100% rename from docs/api/main-config-manager-head.mdx rename to docs/api/main.js configuration/main-config-manager-head.mdx diff --git a/docs/api/main-config-preview-annotations.mdx b/docs/api/main.js configuration/main-config-preview-annotations.mdx similarity index 100% rename from docs/api/main-config-preview-annotations.mdx rename to docs/api/main.js configuration/main-config-preview-annotations.mdx diff --git a/docs/api/main-config-preview-body.mdx b/docs/api/main.js configuration/main-config-preview-body.mdx similarity index 100% rename from docs/api/main-config-preview-body.mdx rename to docs/api/main.js configuration/main-config-preview-body.mdx diff --git a/docs/api/main-config-preview-head.mdx b/docs/api/main.js configuration/main-config-preview-head.mdx similarity index 100% rename from docs/api/main-config-preview-head.mdx rename to docs/api/main.js configuration/main-config-preview-head.mdx diff --git a/docs/api/main-config-refs.mdx b/docs/api/main.js configuration/main-config-refs.mdx similarity index 100% rename from docs/api/main-config-refs.mdx rename to docs/api/main.js configuration/main-config-refs.mdx diff --git a/docs/api/main-config-static-dirs.mdx b/docs/api/main.js configuration/main-config-static-dirs.mdx similarity index 100% rename from docs/api/main-config-static-dirs.mdx rename to docs/api/main.js configuration/main-config-static-dirs.mdx diff --git a/docs/api/main-config-stories.mdx b/docs/api/main.js configuration/main-config-stories.mdx similarity index 100% rename from docs/api/main-config-stories.mdx rename to docs/api/main.js configuration/main-config-stories.mdx diff --git a/docs/api/main-config-swc.mdx b/docs/api/main.js configuration/main-config-swc.mdx similarity index 100% rename from docs/api/main-config-swc.mdx rename to docs/api/main.js configuration/main-config-swc.mdx diff --git a/docs/api/main-config-typescript.mdx b/docs/api/main.js configuration/main-config-typescript.mdx similarity index 100% rename from docs/api/main-config-typescript.mdx rename to docs/api/main.js configuration/main-config-typescript.mdx diff --git a/docs/api/main-config-vite-final.mdx b/docs/api/main.js configuration/main-config-vite-final.mdx similarity index 100% rename from docs/api/main-config-vite-final.mdx rename to docs/api/main.js configuration/main-config-vite-final.mdx diff --git a/docs/api/main-config-webpack-final.mdx b/docs/api/main.js configuration/main-config-webpack-final.mdx similarity index 100% rename from docs/api/main-config-webpack-final.mdx rename to docs/api/main.js configuration/main-config-webpack-final.mdx diff --git a/docs/api/main-config.mdx b/docs/api/main.js configuration/main-config.mdx similarity index 100% rename from docs/api/main-config.mdx rename to docs/api/main.js configuration/main-config.mdx diff --git a/docs/api/new-frameworks.mdx b/docs/api/new-frameworks.mdx index cd5f5bca0c40..358bfdbed91c 100644 --- a/docs/api/new-frameworks.mdx +++ b/docs/api/new-frameworks.mdx @@ -1,5 +1,8 @@ --- title: 'Frameworks' +sidebar: + order: 7 + title: Frameworks --- Storybook is architected to support diverse web frameworks, including React, Vue, Angular, Web Components, Svelte, and over a dozen others. This guide helps you get started on adding new framework support for Storybook. diff --git a/docs/api/parameters.mdx b/docs/api/parameters.mdx index 27dc0ed03b8e..adbfd1a5b71c 100644 --- a/docs/api/parameters.mdx +++ b/docs/api/parameters.mdx @@ -1,5 +1,8 @@ --- title: 'Parameters' +sidebar: + order: 4 + title: Parameters --- Parameters are static metadata used to configure your [stories](../get-started/whats-a-story.md) and [addons](../addons/index.md) in Storybook. They are specified at the story, meta (component), project (global) levels. diff --git a/docs/api/portable-stories/index.mdx b/docs/api/portable-stories/index.mdx new file mode 100644 index 000000000000..e4cd7853f2d5 --- /dev/null +++ b/docs/api/portable-stories/index.mdx @@ -0,0 +1,5 @@ +--- +title: Portable Stories +sidebar: + order: 6 + title: Portable Stories \ No newline at end of file diff --git a/docs/api/portable-stories-jest.mdx b/docs/api/portable-stories/portable-stories-jest.mdx similarity index 99% rename from docs/api/portable-stories-jest.mdx rename to docs/api/portable-stories/portable-stories-jest.mdx index ea4080b980f2..5d8a54a6c38d 100644 --- a/docs/api/portable-stories-jest.mdx +++ b/docs/api/portable-stories/portable-stories-jest.mdx @@ -1,5 +1,6 @@ --- title: 'Portable stories in Jest' +draft: true --- {/* This page is unpublished for now */} diff --git a/docs/api/portable-stories-playwright.mdx b/docs/api/portable-stories/portable-stories-playwright.mdx similarity index 99% rename from docs/api/portable-stories-playwright.mdx rename to docs/api/portable-stories/portable-stories-playwright.mdx index d3b92ab3093d..d23f4a585ebf 100644 --- a/docs/api/portable-stories-playwright.mdx +++ b/docs/api/portable-stories/portable-stories-playwright.mdx @@ -1,5 +1,8 @@ --- title: 'Portable stories in Playwright CT' +sidebar: + order: 1 + title: Playwright --- export const SUPPORTED_RENDERERS = ['react', 'vue']; diff --git a/docs/api/portable-stories-vitest.mdx b/docs/api/portable-stories/portable-stories-vitest.mdx similarity index 99% rename from docs/api/portable-stories-vitest.mdx rename to docs/api/portable-stories/portable-stories-vitest.mdx index ff21c16abc6e..41d7c870ca34 100644 --- a/docs/api/portable-stories-vitest.mdx +++ b/docs/api/portable-stories/portable-stories-vitest.mdx @@ -1,5 +1,6 @@ --- title: 'Portable stories in Vitest' +draft: true --- {/* This page is unpublished for now */} diff --git a/docs/api/stories.mdx b/docs/api/stories.mdx index b5d7ca352d51..3ca94e2f508c 100644 --- a/docs/api/stories.mdx +++ b/docs/api/stories.mdx @@ -1,5 +1,6 @@ --- title: 'Stories' +draft: true --- Storybook is extremely customizable and offers various ways to write your stories. diff --git a/docs/builders/builder-api.mdx b/docs/builders/builder-api.mdx index a24340e3c4dc..c8547b78da6d 100644 --- a/docs/builders/builder-api.mdx +++ b/docs/builders/builder-api.mdx @@ -1,5 +1,8 @@ --- title: 'Builder API' +sidebar: + order: 3 + title: API --- Storybook is architected to support multiple builders, including [Webpack](https://webpack.js.org/), [Vite](https://vitejs.dev/), and [ESBuild](https://esbuild.github.io/). The builder API is the set of interfaces you can use to add a new builder to Storybook. diff --git a/docs/builders/vite.mdx b/docs/builders/vite.mdx index 1b7d65cd8560..867836bde2c0 100644 --- a/docs/builders/vite.mdx +++ b/docs/builders/vite.mdx @@ -1,5 +1,8 @@ --- title: 'Vite' +sidebar: + order: 1 + title: Vite --- Storybook Vite builder bundles your components and stories with [Vite](https://vitejs.dev/), a fast ESM bundler. diff --git a/docs/builders/webpack.mdx b/docs/builders/webpack.mdx index 0619f252a274..9290a6459af7 100644 --- a/docs/builders/webpack.mdx +++ b/docs/builders/webpack.mdx @@ -1,5 +1,8 @@ --- title: 'Webpack' +sidebar: + order: 2 + title: Webpack --- Storybook Webpack builder is the default builder for Storybook. This builder enables you to create a seamless development and testing experience for your components and provides an efficient way to develop UI components in isolation allowing you to leverage your existing Webpack configuration with Storybook. diff --git a/docs/contribute/RFC.mdx b/docs/contribute/RFC.mdx index b046ce9f120f..2d245793ead7 100644 --- a/docs/contribute/RFC.mdx +++ b/docs/contribute/RFC.mdx @@ -1,5 +1,8 @@ --- title: 'RFC process' +sidebar: + order: 1 + title: RFC process --- The RFC (Request for Comment) process is intended to provide a consistent and controlled path for new features to enter the project. It helps ensure that new features are well-designed, well-implemented, and well-tested, and they do not conflict with the project's overall direction and scope. diff --git a/docs/contribute/code.mdx b/docs/contribute/code.mdx index 97f09b2b233b..15da1f8617fa 100644 --- a/docs/contribute/code.mdx +++ b/docs/contribute/code.mdx @@ -1,5 +1,8 @@ --- title: 'Code contributions' +sidebar: + order: 2 + title: Code --- Contribute a new feature or bug fix to [Storybook's monorepo](https://github.com/storybookjs/storybook). This page outlines how to get your environment set up to contribute code. diff --git a/docs/contribute/documentation-updates.mdx b/docs/contribute/documentation/documentation-updates.mdx similarity index 97% rename from docs/contribute/documentation-updates.mdx rename to docs/contribute/documentation/documentation-updates.mdx index 5835a4f10d41..1a20ad8e7707 100644 --- a/docs/contribute/documentation-updates.mdx +++ b/docs/contribute/documentation/documentation-updates.mdx @@ -1,5 +1,8 @@ --- title: 'Documentation updates' +sidebar: + order: 1 + title: Content --- Fix a typo or clarify a section of the docs. This page outlines how to edit the documentation. diff --git a/docs/contribute/documentation/index.mdx b/docs/contribute/documentation/index.mdx new file mode 100644 index 000000000000..fc20e389964a --- /dev/null +++ b/docs/contribute/documentation/index.mdx @@ -0,0 +1,5 @@ +--- +title: Documentation +sidebar: + order: 3 + title: Documentation \ No newline at end of file diff --git a/docs/contribute/new-snippets.mdx b/docs/contribute/documentation/new-snippets.mdx similarity index 99% rename from docs/contribute/new-snippets.mdx rename to docs/contribute/documentation/new-snippets.mdx index f90473563be0..a9e8879b4f36 100644 --- a/docs/contribute/new-snippets.mdx +++ b/docs/contribute/documentation/new-snippets.mdx @@ -1,5 +1,8 @@ --- title: 'Code snippets contributions' +sidebar: + order: 2 + title: Code snippets --- Add or update the code snippets in the documentation. This page outlines how the code snippets are structured. diff --git a/docs/contribute/framework.mdx b/docs/contribute/framework.mdx index cb789721897f..0b84cf4e64d2 100644 --- a/docs/contribute/framework.mdx +++ b/docs/contribute/framework.mdx @@ -1,5 +1,8 @@ --- title: 'Contributing a Storybook framework' +sidebar: + order: 4 + title: Frameworks --- A Storybook framework is a node package that enables out-of-the-box support for either a metaframework (Next.js, NuxtJS, SvelteKit) or a combination of [builder](../builders/index.md) (Webpack, Vite) plus renderer (React, Angular, Vue 3, web components, etc). diff --git a/docs/contribute/how-to-reproduce.mdx b/docs/contribute/how-to-reproduce.mdx index e5f9062008f0..4a91ac5d4527 100644 --- a/docs/contribute/how-to-reproduce.mdx +++ b/docs/contribute/how-to-reproduce.mdx @@ -1,5 +1,8 @@ --- title: 'Create a reproduction' +sidebar: + order: 5 + title: Reproduce --- A reproducible test case lets you isolate the cause of a problem, which is the first step towards fixing it! This page outlines how to get set up to create a reproduction. diff --git a/docs/contribute/roadmap.mdx b/docs/contribute/roadmap.mdx index 509f71b07164..854723a38c3b 100644 --- a/docs/contribute/roadmap.mdx +++ b/docs/contribute/roadmap.mdx @@ -1,6 +1,9 @@ --- title: 'Roadmap' hideRendererSelector: true +sidebar: + order: 6 + title: Roadmap --- The Storybook team maintains a [public roadmap](https://github.com/orgs/storybookjs/projects/20/views/1) in the form of a GitHub project. This page explains what's in the roadmap, how to interpret it, and how to contribute to it. diff --git a/docs/migration-guide/from-older-version.mdx b/docs/migration-guide/from-older-version.mdx index c3b9cde01879..a672d869d00d 100644 --- a/docs/migration-guide/from-older-version.mdx +++ b/docs/migration-guide/from-older-version.mdx @@ -1,5 +1,8 @@ --- title: 'Migration guide from Storybook 6.x to 8.0' +sidebar: + order: 1 + title: Migrate from Storybook 6.x to 8.0 --- Storybook 8 focuses on improving performance, compatibility, and stability. Key features include: