From 9d51b994055a369dac3d56bb661d77d8119262fe Mon Sep 17 00:00:00 2001 From: Aram <37216945+alimpens@users.noreply.github.com> Date: Wed, 24 Jul 2024 13:32:41 +0200 Subject: [PATCH] chore: Update getting started docs (#1451) --- CONTRIBUTING.md | 2 +- .../src/docs/developer-guide/getting-started.docs.mdx | 11 +++++------ 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ce2111a485..12383c4a8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -222,4 +222,4 @@ Contact the maintainers if you want to release a new version of a package. ## :pray: Credits -This document is adapted from a template made by [@jessesquires](https://github.com/jessesquires). +This document is adapted from [a template made by jessesquires](https://github.com/jessesquires/.github). diff --git a/storybook/src/docs/developer-guide/getting-started.docs.mdx b/storybook/src/docs/developer-guide/getting-started.docs.mdx index 15beb4f365..d00f8cebb9 100644 --- a/storybook/src/docs/developer-guide/getting-started.docs.mdx +++ b/storybook/src/docs/developer-guide/getting-started.docs.mdx @@ -11,12 +11,7 @@ import { Meta } from "@storybook/blocks"; Install the packages you need, for instance: ```bash - npm install - @amsterdam/design-system-assets - @amsterdam/design-system-css - @amsterdam/design-system-react - @amsterdam/design-system-react-icons - @amsterdam/design-system-tokens +npm install @amsterdam/design-system-assets @amsterdam/design-system-css @amsterdam/design-system-react @amsterdam/design-system-react-icons @amsterdam/design-system-tokens ``` Import the components and stylesheets you need, for example: @@ -45,3 +40,7 @@ To use the compact mode, import the compact CSS **after** the theme CSS, like so import "@amsterdam/design-system-tokens/dist/index.css"; import "@amsterdam/design-system-tokens/dist/compact.css"; ``` + +## Contributing + +Do you want to contribute to this project? Please review [our Contributing guidelines](https://github.com/Amsterdam/design-system/blob/develop/CONTRIBUTING.md).