From 235c9975f1110f671740af9f0e283c2c1f96e878 Mon Sep 17 00:00:00 2001 From: MoritzWeber Date: Tue, 24 Sep 2024 11:09:14 +0200 Subject: [PATCH] docs: Add index page for Storybook --- frontend/.storybook/main.ts | 6 +++++- frontend/src/storybook/index.mdx | 16 ++++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 frontend/src/storybook/index.mdx diff --git a/frontend/.storybook/main.ts b/frontend/.storybook/main.ts index a1aa6f1cb..0f2f946b4 100644 --- a/frontend/.storybook/main.ts +++ b/frontend/.storybook/main.ts @@ -5,7 +5,11 @@ import type { StorybookConfig } from '@storybook/angular'; const config: StorybookConfig = { - stories: ['../src/**/*.mdx', '../src/**/*.stories.ts'], + stories: [ + '../src/storybook/index.mdx', + '../src/**/*.mdx', + '../src/**/*.stories.ts', + ], addons: [ '@storybook/addon-links', '@storybook/addon-essentials', diff --git a/frontend/src/storybook/index.mdx b/frontend/src/storybook/index.mdx new file mode 100644 index 000000000..9f7d87a78 --- /dev/null +++ b/frontend/src/storybook/index.mdx @@ -0,0 +1,16 @@ +{/* + SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors + SPDX-License-Identifier: Apache-2.0 +*/} + +import { Meta, Title } from '@storybook/blocks'; + + +Welcome to the Storybook of the Capella Collaboration Manager + +This Storybook covers the frontend components of the Capella Collaboration Manager. +We use it for development and visual testing of our components. +A Storybook preview and a change detection using [reg-actions](https://github.com/reg-viz/reg-actions) +is created for each pull request on GitHub automatically. + +If you want to learn about how to write Stories, have a look at our [development documentation](https://dsd-dbs.github.io/capella-collab-manager/development/frontend/storybook/).