Skip to content

Commit

Permalink
docs: add links to storybook versions
Browse files Browse the repository at this point in the history
  • Loading branch information
Th3S4mur41 committed Sep 6, 2023
1 parent ff14574 commit eef6e6b
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions profile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,26 @@

Checkout the README of each of the following **Parallel** packages for more information on how to install and use them and the [Storybook Documentation](https://parallel.eviden.com/docs) for examples.

| Package | Description | Repository | Docs |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [`core`](https://github.com/eviden-parallel/core/pkgs/npm/core) | The core package contains the foundations & core styles of **Parallel**. | [core](https://github.com/eviden-parallel/core) | [Core - Storybook](https://parallel.eviden.com/docs?path=/docs/@eviden-parallel/core_changelog--docs) |
| [`components`](https://github.com/eviden-parallel/components/pkgs/npm/components) | The components package contains all the **Parallel** [web components](https://developer.mozilla.org/en-US/docs/Web/API/Web_Components). | [components](https://github.com/eviden-parallel/components) | [Components - Storybook](https://parallel.eviden.com/docs?path=/docs/@eviden-parallel/components_changelog--docs) |
| [`icons`](https://github.com/eviden-parallel/icons/pkgs/npm/icons) | The icons package contains all the **Parallel** icons. | [icons](https://github.com/eviden-parallel/icons) | [Icons - Storybook](https://parallel.eviden.com/docshttps://main--6489d791288157eccb75d900.chromatic.com/?path=/docs/@eviden-parallel/icons_changelog--docs) |
| [`bootstrap`](https://github.com/eviden-parallel/icons/pkgs/npm/bootstrap) | The bootstrap package contains custom styles to make [Bootsrap](https://getbootstrap.com/) look & feel like **Parallel**. | [bootstrap](https://github.com/eviden-parallel/bootstrap) | |
| Package | Description | Repository |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
| [`core`](https://github.com/eviden-parallel/core/pkgs/npm/core) | The core package contains the foundations & core styles of **Parallel**. | [core](https://github.com/eviden-parallel/core) |
| [`components`](https://github.com/eviden-parallel/components/pkgs/npm/components) | The components package contains all the **Parallel** [web components](https://developer.mozilla.org/en-US/docs/Web/API/Web_Components). | [components](https://github.com/eviden-parallel/components) |
| [`icons`](https://github.com/eviden-parallel/icons/pkgs/npm/icons) | The icons package contains all the **Parallel** icons. | [icons](https://github.com/eviden-parallel/icons) |
| [`bootstrap`](https://github.com/eviden-parallel/icons/pkgs/npm/bootstrap) | The bootstrap package contains custom styles to make [Bootsrap](https://getbootstrap.com/) look & feel like **Parallel**. | [bootstrap](https://github.com/eviden-parallel/bootstrap) |

## 📄 Docs

We use [Storybook](https://storybook.js.org/) to document our **Parallel** components.
You can find the documentation of our current release on [parallel.eviden.com/docs](https://parallel.eviden.com/docs).

### Version

For a specific version, you can check the links below:

| Version | Link |
| ------- | ------------------------------------------------------------------ |
| v1 | [parallel.eviden.com/docs/v1](https://parallel.eviden.com/docs/v1) |
| v2 | [parallel.eviden.com/docs/v2](https://parallel.eviden.com/docs/v2) |

## 🧑‍💻 Contributing

Expand Down

0 comments on commit eef6e6b

Please sign in to comment.