From ad1e5b0c85fa74284744e6718b01656a1208f709 Mon Sep 17 00:00:00 2001 From: Robin Date: Mon, 6 May 2024 08:08:46 -0400 Subject: [PATCH] Improve some documentation (#78) As reported in the Element Design room, there was a dead link in the README and the documentation about how to modify Compound was a bit lacking. --- README.md | 2 +- docs/development.md | 7 +++++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 86a13159..a09c5e15 100644 --- a/README.md +++ b/README.md @@ -25,4 +25,4 @@ Tokens are exported to three platforms - [Development](./docs/development.md) - [Icons](./docs/icons.md) - [Release](./docs/release.md) -- [Synchronise with Figma](./docs/sync-tokens.md) +- [Synchronise with Figma](https://compound.element.io/?path=/docs/design-get-started--docs) diff --git a/docs/development.md b/docs/development.md index fceaaf31..a60cb1fc 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,9 +1,12 @@ # 🤓 Development The tokens are defined under the `tokens/` folder and follow the [tokens.studio specification](https://docs.tokens.studio/tokens/json-schema). -They are then transformed to the supported platforms using [Style Dictionary](https://amzn.github.io/style-dictionary/). +Normally, our designers will update this folder by [syncing it with Figma](https://compound.element.io/?path=/docs/design-get-started--docs). +But if you are maintaining a custom fork and wish to modify the tokens, you can also edit the JSON data in this folder directly. -All consumable tokens are generated under `assets/`. Generate them by running +The tokens are then transformed using [Style Dictionary](https://amzn.github.io/style-dictionary/) into formats which supported platforms can consume. +These generated files live in the `assets/` folder, and the code that generates them can be found in `src/`. +Generate them by running: ``` yarn build