Skip to content

Commit c74ecd6

Browse files
pomfridapomfrida
authored
docs: clarify EDS 2.0 vs eds-core-react@3.x naming (#5126)
* docs: clarify EDS 2.0 vs eds-core-react@3.x naming Add canonical Versioning section to About EDS page explaining the relationship between the design system name (EDS 2.0) and the npm package version (eds-core-react). Cross-reference from dev getting-started, root README, package README, and the Storybook "About EDS 2.0" page. * docs: tighten versioning note wording after review
1 parent 7f5bc4f commit c74ecd6

5 files changed

Lines changed: 20 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,8 @@ See our [storybook](https://storybook.eds.equinor.com/) for more examples.
277277

278278
We're developing the next generation of EDS components under the `/next` entry point. These components are available as **beta releases** for early testing and feedback.
279279

280+
> **Note on naming:** "EDS 2.0" is the design system name; `eds-core-react` is the package version (semver). They are separate; the numbers line up by coincidence. See [Versioning](https://eds.equinor.com/docs/about/about_eds#versioning) for the full explanation.
281+
280282
#### Installation
281283

282284
```sh

‎apps/design-system-docs/docs/about/about_eds.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,16 @@ EDS provides everything you need to build consistent, accessible interfaces:
5656

5757
Start building immediately with tools designed for your workflow.
5858

59+
## Versioning
60+
61+
"EDS 2.0" is the name of the next generation of the design system. Its components currently live in beta under the `/next` entry point of the `eds-core-react` package, alongside the stable EDS 1 components. The package itself is on version `2.x` today, so an installed `eds-core-react@2.x` matching "EDS 2.0" is also a coincidence.
62+
63+
When EDS 2.0 stabilises, the components move out of `/next` and EDS 1 is deprecated. Because removing EDS 1 is a breaking change, the package bumps to `eds-core-react@3.0.0`.
64+
65+
:::info
66+
The numbers line up by coincidence: "2.0" is the design system name, and "3.0.0" is the semver consequence of removing EDS 1. There is no "EDS 3.0" — the package version and the design system name are separate things.
67+
:::
68+
5969
## Support & Community
6070

6171
Visit our [Support page](../support/support.md) for help channels, office hours, and direct access to our team.

‎apps/design-system-docs/docs/about/getting-started/develop/getting_started_development.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ npm install @equinor/eds-core-react
1919
yarn add @equinor/eds-core-react
2020
```
2121

22+
:::note
23+
"EDS 2.0" is the design system name; `eds-core-react` is the package version (semver). They are not the same — see [Versioning](../../about_eds.md#versioning) for the relationship.
24+
:::
25+
2226
### Load fonts
2327

2428
EDS components use the **Equinor** font family. EDS 2.0 (`next`) components additionally require **Inter**. Add the EDS variable font stylesheet to your HTML `<head>` to load both:

‎packages/eds-core-react/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ import { Button, Typography } from '@equinor/eds-core-react'
2121

2222
⚠️ **Experimental** – For testing and feedback only. Not production-ready.
2323

24+
> **Note on naming:** "EDS 2.0" is the design system name; `eds-core-react` is the package version (semver). They are separate; the numbers line up by coincidence. See [Versioning](https://eds.equinor.com/docs/about/about_eds#versioning) for the full explanation.
25+
2426
```bash
2527
npm install @equinor/eds-core-react@beta
2628
```

‎packages/eds-core-react/stories/docs/EDS2.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ import { Meta } from '@storybook/addon-docs/blocks'
66

77
Welcome to the next generation of the Equinor Design System! 🎉
88

9+
> **Note on naming:** "EDS 2.0" is the design system name; `eds-core-react` is the package version (semver). They are separate; the numbers line up by coincidence. See [Versioning](https://eds.equinor.com/docs/about/about_eds#versioning) for the full explanation.
10+
911
## What is EDS 2.0?
1012

1113
EDS 2.0 is a complete redesign of our component library, bringing:

0 commit comments

Comments
 (0)