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

Docs: Introduce Tokens Structure Decision #1763

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

crishpeen
Copy link
Member

Description

Additional context

Issue reference

@crishpeen crishpeen requested a review from a team as a code owner November 19, 2024 15:31
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 19, 2024
Copy link

netlify bot commented Nov 19, 2024

Deploy Preview for spirit-design-system-storybook canceled.

Name Link
🔨 Latest commit 94c7d56
🔍 Latest deploy log https://app.netlify.com/sites/spirit-design-system-storybook/deploys/673caf6c621d8600081a9dab

Copy link

netlify bot commented Nov 19, 2024

Deploy Preview for spirit-design-system ready!

Name Link
🔨 Latest commit 94c7d56
🔍 Latest deploy log https://app.netlify.com/sites/spirit-design-system/deploys/673caf6c54720f0008c9e81b
😎 Deploy Preview https://deploy-preview-1763--spirit-design-system.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 96 (no change from production)
Accessibility: 93 (no change from production)
Best Practices: 100 (no change from production)
SEO: 90 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

3. The `Gradients` and `Shadows` tokens use CSS variables to define the colors. This allows us to theme them.
4. We use scales for tokens that have multiple values. For example, the `Spacing` category contains `space-0`, `space-100`, `space-200`, etc.
We use hundreds for the scale, so our users have plenty of space to add their own values between the predefined ones.
5. The `Theme Tokens` contains folders for each theme.
Copy link
Collaborator

Choose a reason for hiding this comment

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

nitpick (if-minor):

Suggested change
5. The `Theme Tokens` contains folders for each theme.
5. The `Theme Tokens` contains directories for each theme.

By following this structure, we can easily find tokens and we know where to add new tokens. We can also easily add new themes
and we know where to add new tokens for the themes. This structure is easy to understand and maintain.

Our tokens follow the structure described in this decision.
Copy link
Collaborator

Choose a reason for hiding this comment

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

suggestion (if-minor): I think this sentence is unnecessary.


## Context

Our Design System uses design tokens.
Copy link
Collaborator

Choose a reason for hiding this comment

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

suggestion (if-minor): Can you please provide some experience? Like that, we have started to use Figma variables and thus the tokens are exported based on this. Or if there were some pain points with the tokens, so we have created a new structure that solves these issues and so on...

I would like to have here more about why we are doing this, please :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants