Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add json docs #15

Merged
merged 5 commits into from
Mar 8, 2024
Merged

Add json docs #15

merged 5 commits into from
Mar 8, 2024

Conversation

jsimplicio
Copy link
Member

@jsimplicio jsimplicio commented Mar 8, 2024

This adds basic documentation behind the JSON design tokens.

@@ -0,0 +1,60 @@
# Design tokens
Copy link

@TGiles TGiles Mar 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to change the JSON part of the name to lower case, otherwise the file doesn't show up

Here's how to build design tokens for desktop:

```sh
$ cd toolkit/…/design-system
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
$ cd toolkit/…/design-system

Comment on lines 2 to 4
## Source of truth
### Background
The benefit of storing design tokens with a platform-agnostic format such as JSON is that it can be converted or translated into other languages or tools (e.g CSS, Swift, Kotlin, Figma).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Source of truth
### Background
The benefit of storing design tokens with a platform-agnostic format such as JSON is that it can be converted or translated into other languages or tools (e.g CSS, Swift, Kotlin, Figma).
### Background
`design-tokens.json` is the source of truth for all our design tokens. The benefit of storing design tokens with a platform-agnostic format such as JSON is that it can be converted or translated into other languages or tools (e.g CSS, Swift, Kotlin, Figma).

Copy link
Collaborator

@mstriemer mstriemer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@jsimplicio jsimplicio merged this pull request into json-design-tokens Mar 8, 2024
@jsimplicio jsimplicio deleted the add-json-docs branch March 8, 2024 18:22
TGiles pushed a commit that referenced this pull request Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants