-
Notifications
You must be signed in to change notification settings - Fork 1
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 glossary page #7
Draft
ChucKN0risK
wants to merge
7
commits into
tokens-studio:main
Choose a base branch
from
ChucKN0risK:add-glossary-page
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
affea56
chore: Fix typos
ChucKN0risK 679c2d9
content: start glossary page
ChucKN0risK 917d493
Update .gitignore
ChucKN0risK e172d2f
Moved .prettierignore to .history folder to fix formatting issues
ChucKN0risK 5d30b01
Merge branch 'main' into add-glossary-page
ChucKN0risK 96f3827
Add token space definition
ChucKN0risK 3ee17e8
Fix typo
ChucKN0risK File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
node_modules | ||
.astro/ | ||
.history/ | ||
dist/ | ||
.DS_Store | ||
.history/ |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
title: Glossary | ||
--- | ||
|
||
![Resolver spec visual draft](./docs/public/resolver-spec-food-analogy-drawing.jpg) | ||
|
||
:::note | ||
Creating tokens is like cooking. You can cook an infinity of dishes (final tokens) by following recipes (sources) which are a combination of different types (dimension) of food (modifiers). | ||
::: | ||
|
||
## Token set | ||
|
||
A token set is a group of tokens. You have 2 types of token sets: | ||
|
||
1. [modifier](#modifier) token sets | ||
2. [source](#source) token sets | ||
|
||
## Dimension | ||
|
||
Dimensions are categories used to organize your tokens. See them as contexts in which token values might change: | ||
|
||
- Brands | ||
- Surface | ||
- Language direction | ||
- Themes | ||
- Platform | ||
- Screen size | ||
- Density | ||
- Component | ||
- State | ||
- Variant | ||
- Contrast | ||
- ... | ||
|
||
## Modifier | ||
|
||
A modifier token set is a group of token used by source token set(s). You'll usually want to organize them in different [dimensions](#dimension). | ||
|
||
![Dimension examples](./docs/public/spectrum-adaptive-ui-concept.png) | ||
|
||
## Source | ||
|
||
A source set is a combination of one or several modifier set used to match a specific use case. For instance, generating a themes token sets based on several modifier sets. | ||
|
||
## Resolver | ||
|
||
A design token resolver is a function responsible for creating design tokens respecting [the DTCG spec](https://first-editors-draft.tr.designtokens.org/format/) from another source of data or logic. | ||
|
||
## Token space | ||
|
||
A single large token set that then forms the final set of tokens you can address with keys like `colors.foo.500`. | ||
|
||
## Resolution request | ||
|
||
TBD | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This would be the request for to get some final tokens , so its the ordering of the dish in your cooking analogy.
I mention in the docs that it would likely be async as the token sets files might need to be read from some storage before the actual processing can be done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok thanks. Do you think it's important enough to add this to the glossary?