From c9b9a0929fa255d1085c9f5a2f6a197e8eb2a83c Mon Sep 17 00:00:00 2001 From: Charles de Dreuille Date: Thu, 13 Jun 2024 18:34:00 +0100 Subject: [PATCH] Updated indexes root --- docs/addons/index.mdx | 3 +++ docs/api/index.mdx | 3 +++ docs/builders/index.mdx | 3 +++ docs/configure/index.mdx | 3 +++ docs/contribute/index.mdx | 3 +++ docs/essentials/index.mdx | 3 +++ docs/faq.mdx | 3 +++ docs/migration-guide/index.mdx | 3 +++ docs/sharing/index.mdx | 3 +++ docs/writing-docs/index.mdx | 3 +++ docs/writing-stories/index.mdx | 3 +++ docs/writing-tests/index.mdx | 3 +++ 12 files changed, 36 insertions(+) diff --git a/docs/addons/index.mdx b/docs/addons/index.mdx index dade7e7e26f9..c67940dff7e1 100644 --- a/docs/addons/index.mdx +++ b/docs/addons/index.mdx @@ -1,6 +1,9 @@ --- title: 'Introduction to addons' hideRendererSelector: true +sidebar: + order: 7 + title: Addons --- Addons extend Storybook with features and integrations that are not built into the core. Most Storybook features are implemented as addons. For instance: [documentation](../writing-docs/index.md), [accessibility testing](https://github.com/storybookjs/storybook/tree/master/addons/a11y), [interactive controls](../essentials/controls.md), among others. diff --git a/docs/api/index.mdx b/docs/api/index.mdx index 7c02e18ba786..2e81ebf435ee 100644 --- a/docs/api/index.mdx +++ b/docs/api/index.mdx @@ -1,6 +1,9 @@ --- title: 'API references' hideRendererSelector: true +sidebar: + order: 10 + title: API --- {/* diff --git a/docs/builders/index.mdx b/docs/builders/index.mdx index 14235094dee2..e49af3d3beab 100644 --- a/docs/builders/index.mdx +++ b/docs/builders/index.mdx @@ -1,6 +1,9 @@ --- title: 'Builders' hideRendererSelector: true +sidebar: + order: 9 + title: Builders --- Storybook, at its core, is powered by builders such as Webpack and Vite. These builders spin up a development environment, compile your code—Javascript, CSS, and MDX—into an executable bundle and update the browser in real-time. diff --git a/docs/configure/index.mdx b/docs/configure/index.mdx index 54785bddc01d..50526680a093 100644 --- a/docs/configure/index.mdx +++ b/docs/configure/index.mdx @@ -1,5 +1,8 @@ --- title: 'Configure Storybook' +sidebar: + order: 8 + title: Configure --- Storybook is configured via a folder called `.storybook`, which contains various configuration files. diff --git a/docs/contribute/index.mdx b/docs/contribute/index.mdx index 7e0b972d3f41..9b37172f3c68 100644 --- a/docs/contribute/index.mdx +++ b/docs/contribute/index.mdx @@ -1,6 +1,9 @@ --- title: 'How to contribute' hideRendererSelector: true +sidebar: + order: 11 + title: Contribute --- Storybook is a community-oriented open source project that welcomes contributions. Some of our most popular features started with a developer wanting to solve a problem for themselves. diff --git a/docs/essentials/index.mdx b/docs/essentials/index.mdx index de6be26ae655..afdee61b1977 100644 --- a/docs/essentials/index.mdx +++ b/docs/essentials/index.mdx @@ -1,6 +1,9 @@ --- title: 'Essential addons' hideRendererSelector: true +sidebar: + order: 6 + title: Essential addons --- A major strength of Storybook are [addons](https://storybook.js.org/addons) that extend Storybook’s UI and behavior. Storybook ships by default with a set of “essential” addons that add to the initial user experience. There are many third-party addons as well as “official” addons developed by the Storybook core team. diff --git a/docs/faq.mdx b/docs/faq.mdx index fd75be13a599..728a826965bc 100644 --- a/docs/faq.mdx +++ b/docs/faq.mdx @@ -1,5 +1,8 @@ --- title: 'Frequently Asked Questions' +sidebar: + order: 12 + title: FAQ --- Here are some answers to frequently asked questions. If you have a question, you can ask it in our [GitHub discussions](https://github.com/storybookjs/storybook/discussions/new?category=help). diff --git a/docs/migration-guide/index.mdx b/docs/migration-guide/index.mdx index 76b086cd4a4d..1810578d2a45 100644 --- a/docs/migration-guide/index.mdx +++ b/docs/migration-guide/index.mdx @@ -1,5 +1,8 @@ --- title: 'Migration guide for Storybook 8.0' +sidebar: + order: 13 + title: Migrate to 8.0 --- Storybook 8 focuses on improving performance, compatibility, and stability. Key features include: diff --git a/docs/sharing/index.mdx b/docs/sharing/index.mdx index 8c6992d3c28c..f0cef6680eeb 100644 --- a/docs/sharing/index.mdx +++ b/docs/sharing/index.mdx @@ -1,6 +1,9 @@ --- title: 'Sharing' hideRendererSelector: true +sidebar: + order: 5 + title: Sharing --- You have your components ready and tested. That's great! Now you want to make your component library available to your team or community to help them understand how they work. There are multiple ways you can do that. You can publish your Storybook to services like Chromatic, embed some of your stories in your own website, or use third party services like Figma. diff --git a/docs/writing-docs/index.mdx b/docs/writing-docs/index.mdx index aa656f0e9764..a20c41752773 100644 --- a/docs/writing-docs/index.mdx +++ b/docs/writing-docs/index.mdx @@ -1,6 +1,9 @@ --- title: 'How to document components' hideRendererSelector: true +sidebar: + order: 3 + title: Docs --- When you write component stories during development, you also create basic documentation to revisit later. diff --git a/docs/writing-stories/index.mdx b/docs/writing-stories/index.mdx index 80c912d09c69..91091784a2de 100644 --- a/docs/writing-stories/index.mdx +++ b/docs/writing-stories/index.mdx @@ -1,5 +1,8 @@ --- title: 'How to write stories' +sidebar: + order: 2 + title: Stories --- diff --git a/docs/writing-tests/index.mdx b/docs/writing-tests/index.mdx index c8c5aff6aa95..6f07ec18044a 100644 --- a/docs/writing-tests/index.mdx +++ b/docs/writing-tests/index.mdx @@ -1,6 +1,9 @@ --- title: 'How to test UIs with Storybook' hideRendererSelector: true +sidebar: + order: 4 + title: Testing --- Storybook provides a clean-room environment for testing components in isolation. Stories make it easy to explore a component in all its variations, no matter how complex.