Skip to content

Commit

Permalink
Improve some documentation (#78)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
robintown authored May 6, 2024
1 parent 53d1456 commit ad1e5b0
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
7 changes: 5 additions & 2 deletions docs/development.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit ad1e5b0

Please sign in to comment.