Skip to content

Commit

Permalink
fix: review
Browse files Browse the repository at this point in the history
  • Loading branch information
jeripeierSBB committed Apr 24, 2024
1 parent 4f71835 commit 24f8e05
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .storybook/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { StorybookConfig } from '@storybook/web-components-vite';
import { type BuildOptions, type UserConfig, mergeConfig } from 'vite';

const config: StorybookConfig = {
stories: ['../docs/**/*.mdx', '../src/**/*.stories.ts'],
stories: ['../src/**/*.mdx', '../src/**/*.stories.ts'],
addons: ['@storybook/addon-essentials', '@storybook/addon-a11y', '@storybook/addon-interactions'],
framework: {
name: '@storybook/web-components-vite',
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
## 🎯 Our aim

To fulfill our [Vision](./docs/VISION.mdx), we are building and maintaining Lyne, our Design System, which is and acts
To fulfill our [Vision](./docs/VISION.md), we are building and maintaining Lyne, our Design System, which is and acts
as our common language — our Single Source of Truth.
For this purpose we use [Design Tokens](https://github.com/lyne-design-system/lyne-design-tokens) as our design abstractions.
Those [Design Tokens](https://github.com/lyne-design-system/lyne-design-tokens) are consumed by Lyne Components and are integrated within our documentation.
Expand All @@ -18,7 +18,7 @@ Lyne Design Tokens and Lyne Components are available for developers and designer

- General docs: [digital.sbb.ch](https://digital.sbb.ch)
- Component docs: [Storybook](https://lyne-storybook.app.sbb.ch)
- [Getting started guide](./docs/GETTING_STARTED.mdx)
- [Getting started guide](./docs/GETTING_STARTED.md)

## 🔗 Packages

Expand Down
4 changes: 0 additions & 4 deletions docs/GETTING_STARTED.mdx → docs/GETTING_STARTED.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
import { Meta } from '@storybook/blocks';

<Meta title="introduction/Getting Started" />

# Getting Started

Basic steps to integrate the lyne components into your project.
Expand Down
4 changes: 0 additions & 4 deletions docs/VISION.mdx → docs/VISION.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
import { Meta } from '@storybook/blocks';

<Meta title="introduction/Vision" />

# Lyne Design System — Vision

## What _Lyne_ is and why we need it
Expand Down
7 changes: 7 additions & 0 deletions src/storybook/docs/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { Markdown, Meta } from '@storybook/blocks';

import GettingStarted from '../../../docs/GETTING_STARTED.md?raw';

<Meta title="introduction/Getting Started" />

<Markdown>{GettingStarted}</Markdown>
7 changes: 7 additions & 0 deletions src/storybook/docs/vision.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { Markdown, Meta } from '@storybook/blocks';

import Vision from '../../../docs/VISION.md?raw';

<Meta title="introduction/Vision" />

<Markdown>{Vision}</Markdown>

0 comments on commit 24f8e05

Please sign in to comment.