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

Ensure core design tokens are documented with a description attribute as an example #1948

Closed
Tracked by #246
adamstankiewicz opened this issue Jan 24, 2023 · 2 comments · Fixed by #2112
Closed
Tracked by #246
Assignees
Labels

Comments

@adamstankiewicz
Copy link
Member

adamstankiewicz commented Jan 24, 2023

Part of the official W3C design token space being proposed is a description field to give a brief human-readable string to describe each token.

Given we have nearly 1500 tokens/variables, I believe asking to add description field to all of them in one go is a bit much and out of scope.

However, I would like for us to implement the description field on at least a subset of the more important tokens (e.g., global colors, spacing, and typography) to demonstrate the capabilities and show an example of the vision for all the tokens.

See https://design-tokens.github.io/community-group/format/#description fore more details.

@adamstankiewicz adamstankiewicz added this to the Design tokens with style-dictionary milestone Jan 24, 2023
@adamstankiewicz adamstankiewicz added the engineering Engineering label Jan 24, 2023
@adamstankiewicz adamstankiewicz changed the title Ensure core design tokens are documented with a description attribute Ensure core design tokens are documented with a description attribute as an example Jan 24, 2023
@adamstankiewicz
Copy link
Member Author

Maybe just colors and spacing 😄

@viktorrusakov viktorrusakov self-assigned this Jan 30, 2023
@monteri
Copy link
Contributor

monteri commented Mar 3, 2023

#2112

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Closed
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants