Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added the Welcome page for the Design System (Storybook) #4268

Merged
merged 4 commits into from
Oct 24, 2024

Conversation

swapnilmmane
Copy link
Contributor

Added the Welcome page for the Design System (Storybook)
Also included MDX file configuration to support writing plain docs, and added assets to the static directory to serve images and other resources.

Storybook

Changes

In Storybook we can use MDX files to create plain documentation. To achieve this, we added the MDX file configuration in the Storybook setup:

const config: StorybookConfig = {
  stories: ["../docs/stories/**/*.mdx", "../src/**/*.stories.@(js|jsx|mjs|ts|tsx)"],
};

Additionally, to serve images and other static assets, we defined the following in the Storybook configuration:

staticDirs: ["../assets"],

How Has This Been Tested?

Tested manually.

Also included MDX file configuration to support writing plain docs,
and added assets to the static directory to serve images and other resources.
@leopuleo leopuleo merged commit dba63f5 into feat/new-admin-ui Oct 24, 2024
12 checks passed
@swapnilmmane swapnilmmane deleted the storybook-docs branch October 29, 2024 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants