From 7e9d314b406a32cb023f2fb9778b96769284f244 Mon Sep 17 00:00:00 2001 From: Kyle Gach Date: Wed, 13 Mar 2024 15:57:41 -0600 Subject: [PATCH] Fix broken links --- docs/get-started/index.md | 18 +++++++++--------- ...orybook-production-mode.with-builder.js.mdx | 2 +- docs/writing-docs/index.md | 2 +- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/get-started/index.md b/docs/get-started/index.md index 8e2e3cdb8d28..a89a028e7357 100644 --- a/docs/get-started/index.md +++ b/docs/get-started/index.md @@ -115,22 +115,22 @@ Want to know more about installing Storybook? Check out the [installation guide] Storybook is a powerful tool that can help you with many aspects of your UI development workflow. Here are some of the main concepts to get you started.
- +

Stories

A story captures the rendered state of a UI component. Each component can have multiple stories, where each story describes a different component state.

 - +

Docs

Storybook can analyze your components to automatically create documentation alongside your stories. This automatic documentation makes it easier for you to create UI library usage guidelines, design system sites, and more.

 - +

Testing

Stories are a pragmatic starting point for your UI testing strategy. You already write stories as a natural part of UI development, so testing those stories is a low-effort way to prevent UI bugs over time.

 - +

Sharing

Publishing your Storybook allows you to share your work with others. You can also embed your stories in places like Notion or Figma.

@@ -142,7 +142,7 @@ Storybook is a powerful tool that can help you with many aspects of your UI deve Once you've learned the basics, explore these other ways to get the most out of Storybook.
- + Essential addons @@ -154,19 +154,19 @@ Once you've learned the basics, explore these other ways to get the most out of Recipes - + Builders - + How to contribute - + Migrate to 8.0 - + FAQ diff --git a/docs/snippets/angular/build-storybook-production-mode.with-builder.js.mdx b/docs/snippets/angular/build-storybook-production-mode.with-builder.js.mdx index 326bfdb04741..8532b7a3646f 100644 --- a/docs/snippets/angular/build-storybook-production-mode.with-builder.js.mdx +++ b/docs/snippets/angular/build-storybook-production-mode.with-builder.js.mdx @@ -1,6 +1,6 @@ ```shell # Builds Storybook with Angular's custom builder -# See https://storybook.js.org/docs/get-started/install +# See https://storybook.js.org/docs/get-started/angular # to learn how to create the custom builder ng run my-project:build-storybook ``` diff --git a/docs/writing-docs/index.md b/docs/writing-docs/index.md index 0c9acac972b5..aa656f0e9764 100644 --- a/docs/writing-docs/index.md +++ b/docs/writing-docs/index.md @@ -9,7 +9,7 @@ Storybook gives you tools to expand this essential documentation with prose and ![Docs page](./docs-completed.png) -If you're including Storybook in your project for the [first time](../get-started/install.md), we provide you with a [documentation page](./autodocs.md) ("Autodocs" for short), positioned near your stories. It's a baseline template automatically generated, listing your existing stories and relevant metadata. +If you're including Storybook in your project for the [first time](../get-started/index.md), we provide you with a [documentation page](./autodocs.md) ("Autodocs" for short), positioned near your stories. It's a baseline template automatically generated, listing your existing stories and relevant metadata. Additionally, you can customize this template if needed or create free-form pages for each component using [MDX](./mdx.md). In both cases, you’ll use Doc Blocks as the building blocks to create full-featured documentation.