Skip to content

Commit

Permalink
Merge pull request #1837 from DSD-DBS/storybook-index
Browse files Browse the repository at this point in the history
docs: Add index page for Storybook
  • Loading branch information
MoritzWeber0 authored Sep 24, 2024
2 parents b5a038d + 235c997 commit 6e93782
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
6 changes: 5 additions & 1 deletion frontend/.storybook/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
16 changes: 16 additions & 0 deletions frontend/src/storybook/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{/*
SPDX-FileCopyrightText: Copyright DB InfraGO AG and contributors
SPDX-License-Identifier: Apache-2.0
*/}

import { Meta, Title } from '@storybook/blocks';

<Meta title="Storybook Introduction" />
<Title>Welcome to the Storybook of the Capella Collaboration Manager</Title>

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/).

0 comments on commit 6e93782

Please sign in to comment.