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.

Sign up for GitHub

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

chore: Update getting started docs #1451

Merged
merged 3 commits into from
Jul 24, 2024
+6 −7
Merged

chore: Update getting started docs #1451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6d49e09
Revert install pkgs to single line, multiline didn't copy well
alimpens Jul 24, 2024
6b7c374
Link directly to template
alimpens Jul 24, 2024
fb2e0f4
Link to CONTRIBUTING.md, fix install line
alimpens Jul 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
11 changes: 5 additions & 6 deletions storybook/src/docs/developer-guide/getting-started.docs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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).