Finish all docs

storybookjs · Jun 14, 2024 · 010d657 · 010d657
1 parent 5b52962
commit 010d657
Show file tree

Hide file tree

Showing 64 changed files with 76 additions and 0 deletions.
diff --git 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
@@ -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
@@ -1,5 +1,8 @@
 ---
 title: 'Component Story Format (CSF)'
+sidebar:
+  order: 2
+  title: Component Story Format (CSF)
 ---
 
 <YouTubeCallout id="uH9_dfc-6Kc" title="Test components the EASY way | Component Story Format 3" />

diff --git a/docs/api/doc-block-argtypes.mdx → docs/api/doc-blocks/doc-block-argtypes.mdx b/docs/api/doc-block-argtypes.mdx → docs/api/doc-blocks/doc-block-argtypes.mdx
diff --git a/docs/api/doc-block-canvas.mdx → docs/api/doc-blocks/doc-block-canvas.mdx b/docs/api/doc-block-canvas.mdx → docs/api/doc-blocks/doc-block-canvas.mdx
diff --git a/docs/api/doc-block-colorpalette.mdx → ...api/doc-blocks/doc-block-colorpalette.mdx b/docs/api/doc-block-colorpalette.mdx → ...api/doc-blocks/doc-block-colorpalette.mdx
diff --git a/docs/api/doc-block-controls.mdx → docs/api/doc-blocks/doc-block-controls.mdx b/docs/api/doc-block-controls.mdx → docs/api/doc-blocks/doc-block-controls.mdx
diff --git a/docs/api/doc-block-description.mdx → .../api/doc-blocks/doc-block-description.mdx b/docs/api/doc-block-description.mdx → .../api/doc-blocks/doc-block-description.mdx
diff --git a/docs/api/doc-block-icongallery.mdx → .../api/doc-blocks/doc-block-icongallery.mdx b/docs/api/doc-block-icongallery.mdx → .../api/doc-blocks/doc-block-icongallery.mdx
diff --git a/docs/api/doc-block-markdown.mdx → docs/api/doc-blocks/doc-block-markdown.mdx b/docs/api/doc-block-markdown.mdx → docs/api/doc-blocks/doc-block-markdown.mdx
diff --git a/docs/api/doc-block-meta.mdx → docs/api/doc-blocks/doc-block-meta.mdx b/docs/api/doc-block-meta.mdx → docs/api/doc-blocks/doc-block-meta.mdx
diff --git a/docs/api/doc-block-primary.mdx → docs/api/doc-blocks/doc-block-primary.mdx b/docs/api/doc-block-primary.mdx → docs/api/doc-blocks/doc-block-primary.mdx
diff --git a/docs/api/doc-block-source.mdx → docs/api/doc-blocks/doc-block-source.mdx b/docs/api/doc-block-source.mdx → docs/api/doc-blocks/doc-block-source.mdx
diff --git a/docs/api/doc-block-stories.mdx → docs/api/doc-blocks/doc-block-stories.mdx b/docs/api/doc-block-stories.mdx → docs/api/doc-blocks/doc-block-stories.mdx
diff --git a/docs/api/doc-block-story.mdx → docs/api/doc-blocks/doc-block-story.mdx b/docs/api/doc-block-story.mdx → docs/api/doc-blocks/doc-block-story.mdx
diff --git a/docs/api/doc-block-subtitle.mdx → docs/api/doc-blocks/doc-block-subtitle.mdx b/docs/api/doc-block-subtitle.mdx → docs/api/doc-blocks/doc-block-subtitle.mdx
diff --git a/docs/api/doc-block-title.mdx → docs/api/doc-blocks/doc-block-title.mdx b/docs/api/doc-block-title.mdx → docs/api/doc-blocks/doc-block-title.mdx
diff --git a/docs/api/doc-block-typeset.mdx → docs/api/doc-blocks/doc-block-typeset.mdx b/docs/api/doc-block-typeset.mdx → docs/api/doc-blocks/doc-block-typeset.mdx
diff --git a/docs/api/doc-block-unstyled.mdx → docs/api/doc-blocks/doc-block-unstyled.mdx b/docs/api/doc-block-unstyled.mdx → docs/api/doc-blocks/doc-block-unstyled.mdx
diff --git a/docs/api/doc-block-useof.mdx → docs/api/doc-blocks/doc-block-useof.mdx b/docs/api/doc-block-useof.mdx → docs/api/doc-blocks/doc-block-useof.mdx
diff --git a/docs/api/doc-blocks/index.mdx b/docs/api/doc-blocks/index.mdx
@@ -0,0 +1,6 @@
+---
+title: Doc Blocks
+sidebar:
+  order: 5
+  title: Doc Blocks
+---
diff --git a/docs/api/main.js configuration/index.mdx 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
+---
diff --git a/docs/api/main-config-addons.mdx → ...n.js configuration/main-config-addons.mdx b/docs/api/main-config-addons.mdx → ...n.js configuration/main-config-addons.mdx
diff --git a/docs/api/main-config-babel-default.mdx → ...nfiguration/main-config-babel-default.mdx b/docs/api/main-config-babel-default.mdx → ...nfiguration/main-config-babel-default.mdx
diff --git a/docs/api/main-config-babel.mdx → ...in.js configuration/main-config-babel.mdx b/docs/api/main-config-babel.mdx → ...in.js configuration/main-config-babel.mdx
diff --git a/docs/api/main-config-build.mdx → ...in.js configuration/main-config-build.mdx b/docs/api/main-config-build.mdx → ...in.js configuration/main-config-build.mdx
diff --git a/docs/api/main-config-core.mdx → ...ain.js configuration/main-config-core.mdx b/docs/api/main-config-core.mdx → ...ain.js configuration/main-config-core.mdx
diff --git a/docs/api/main-config-docs.mdx → ...ain.js configuration/main-config-docs.mdx b/docs/api/main-config-docs.mdx → ...ain.js configuration/main-config-docs.mdx
diff --git a/docs/api/main-config-env.mdx → ...main.js configuration/main-config-env.mdx b/docs/api/main-config-env.mdx → ...main.js configuration/main-config-env.mdx
diff --git a/docs/api/main-config-features.mdx → ...js configuration/main-config-features.mdx b/docs/api/main-config-features.mdx → ...js configuration/main-config-features.mdx
diff --git a/docs/api/main-config-framework.mdx → ...s configuration/main-config-framework.mdx b/docs/api/main-config-framework.mdx → ...s configuration/main-config-framework.mdx
diff --git a/docs/api/main-config-indexers.mdx → ...js configuration/main-config-indexers.mdx b/docs/api/main-config-indexers.mdx → ...js configuration/main-config-indexers.mdx
diff --git a/docs/api/main-config-log-level.mdx → ...s configuration/main-config-log-level.mdx b/docs/api/main-config-log-level.mdx → ...s configuration/main-config-log-level.mdx
diff --git a/docs/api/main-config-manager-head.mdx → ...onfiguration/main-config-manager-head.mdx b/docs/api/main-config-manager-head.mdx → ...onfiguration/main-config-manager-head.mdx
diff --git a/docs/api/main-config-preview-annotations.mdx → ...ation/main-config-preview-annotations.mdx b/docs/api/main-config-preview-annotations.mdx → ...ation/main-config-preview-annotations.mdx
diff --git a/docs/api/main-config-preview-body.mdx → ...onfiguration/main-config-preview-body.mdx b/docs/api/main-config-preview-body.mdx → ...onfiguration/main-config-preview-body.mdx
diff --git a/docs/api/main-config-preview-head.mdx → ...onfiguration/main-config-preview-head.mdx b/docs/api/main-config-preview-head.mdx → ...onfiguration/main-config-preview-head.mdx
diff --git a/docs/api/main-config-refs.mdx → ...ain.js configuration/main-config-refs.mdx b/docs/api/main-config-refs.mdx → ...ain.js configuration/main-config-refs.mdx
diff --git a/docs/api/main-config-static-dirs.mdx → ...configuration/main-config-static-dirs.mdx b/docs/api/main-config-static-dirs.mdx → ...configuration/main-config-static-dirs.mdx
diff --git a/docs/api/main-config-stories.mdx → ....js configuration/main-config-stories.mdx b/docs/api/main-config-stories.mdx → ....js configuration/main-config-stories.mdx
diff --git a/docs/api/main-config-swc.mdx → ...main.js configuration/main-config-swc.mdx b/docs/api/main-config-swc.mdx → ...main.js configuration/main-config-swc.mdx
diff --git a/docs/api/main-config-typescript.mdx → ... configuration/main-config-typescript.mdx b/docs/api/main-config-typescript.mdx → ... configuration/main-config-typescript.mdx
diff --git a/docs/api/main-config-vite-final.mdx → ... configuration/main-config-vite-final.mdx b/docs/api/main-config-vite-final.mdx → ... configuration/main-config-vite-final.mdx
diff --git a/docs/api/main-config-webpack-final.mdx → ...nfiguration/main-config-webpack-final.mdx b/docs/api/main-config-webpack-final.mdx → ...nfiguration/main-config-webpack-final.mdx
diff --git a/docs/api/main-config.mdx → ...api/main.js configuration/main-config.mdx b/docs/api/main-config.mdx → ...api/main.js configuration/main-config.mdx
diff --git 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
@@ -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
@@ -0,0 +1,5 @@
+---
+title: Portable Stories
+sidebar:
+  order: 6
+  title: Portable Stories
diff --git a/docs/api/portable-stories-jest.mdx → ...ortable-stories/portable-stories-jest.mdx b/docs/api/portable-stories-jest.mdx → ...ortable-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 → ...e-stories/portable-stories-playwright.mdx b/docs/api/portable-stories-playwright.mdx → ...e-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 → ...table-stories/portable-stories-vitest.mdx b/docs/api/portable-stories-vitest.mdx → ...table-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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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 → ...e/documentation/documentation-updates.mdx b/docs/contribute/documentation-updates.mdx → ...e/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
@@ -0,0 +1,5 @@
+---
+title: Documentation
+sidebar:
+  order: 3
+  title: Documentation
diff --git a/docs/contribute/new-snippets.mdx → ...contribute/documentation/new-snippets.mdx b/docs/contribute/new-snippets.mdx → ...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
@@ -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
@@ -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
@@ -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
@@ -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: