Skip to content

Commit

Permalink
Updated indexes root
Browse files Browse the repository at this point in the history
  • Loading branch information
cdedreuille committed Jun 13, 2024
1 parent f15f059 commit c9b9a09
Show file tree
Hide file tree
Showing 12 changed files with 36 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/addons/index.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/api/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: 'API references'
hideRendererSelector: true
sidebar:
order: 10
title: API
---

{/*
Expand Down
3 changes: 3 additions & 0 deletions docs/builders/index.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/configure/index.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/contribute/index.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/essentials/index.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/faq.mdx
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
3 changes: 3 additions & 0 deletions docs/migration-guide/index.mdx
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
3 changes: 3 additions & 0 deletions docs/sharing/index.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/writing-docs/index.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 3 additions & 0 deletions docs/writing-stories/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: 'How to write stories'
sidebar:
order: 2
title: Stories
---

<YouTubeCallout id="P0WHt_L0-2g" title="How to write Storybook stories | Component Story Format" />
Expand Down
3 changes: 3 additions & 0 deletions docs/writing-tests/index.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit c9b9a09

Please sign in to comment.