@mindvalley/design-system 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -1
- package/docs/CONTRIBUTION.md +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,7 +15,8 @@ The design system has the Mindvalley Design Language as its foundation.
|
|
|
15
15
|
It aims to make cross-brand UI development as fast as possible while maintaining a high level of quality and accessibility and reducing developer effort.
|
|
16
16
|
|
|
17
17
|
#### Getting started
|
|
18
|
-
First, we recommend going through the [
|
|
18
|
+
First, we recommend going through the [figma design system](https://www.figma.com/file/Gmdp0kAAYsmBgCthFjGkpY/MV-Core?node-id=6437%3A207257). It captures our current views on how best to use the design in your daily work. Then, you can read the following guides:
|
|
19
|
+
|
|
19
20
|
1. The [usage guide](docs/USAGE.md), if you want to start using the design system in your project/repo.
|
|
20
21
|
2. The [contribution](docs/CONTRIBUTION.md) and [release](docs/RELEASING.md) guides if you want to contribute to the repo.
|
|
21
22
|
|
|
@@ -23,6 +24,9 @@ First, we recommend going through the [brand guideline](https://brand.mindvalley
|
|
|
23
24
|
From this point onwards, there will be continous mention of the word *token(s)* or *design token(s)*.
|
|
24
25
|
Get an understanding of what they are here 👉 [what are design tokens?](https://css-tricks.com/what-are-design-tokens/)
|
|
25
26
|
|
|
27
|
+
In the case you don't have access to mentioned figma design system, you can reach out to the channel listed in the [help section](#🤷🏽♂️-need-help)
|
|
28
|
+
and access will be granted.
|
|
29
|
+
|
|
26
30
|
#### :books: Usage
|
|
27
31
|
See the comprehensive [usage guide](docs/USAGE.md).
|
|
28
32
|
|
package/docs/CONTRIBUTION.md
CHANGED
|
@@ -68,7 +68,7 @@ Let's look at some important directories.
|
|
|
68
68
|
```
|
|
69
69
|
###### src/properties/
|
|
70
70
|
This is the source of the design tokens. For now, we have the tokens checked in as JSON files.
|
|
71
|
-
The process of updating the payload is manual, implying that when there are changes in the tokens, one must
|
|
71
|
+
The process of updating the payload is manual, implying that when there are changes in the tokens, one must get the updated token from the [figma colors file](https://www.figma.com/file/Gmdp0kAAYsmBgCthFjGkpY/MV-Core?node-id=6437%3A207257) and update the files in this directory.
|
|
72
72
|
|
|
73
73
|
*Yes, it's a manual step for now, automation will follow later.*
|
|
74
74
|
|