-
Notifications
You must be signed in to change notification settings - Fork 152
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
Improve tokens documentation #4566
base: master
Are you sure you want to change the base?
Conversation
Storybook staging is available at https://kiwicom-orbit-dsil-improve-tokens-docs.surge.sh |
Size Change: 0 B Total Size: 459 kB
ℹ️ View Unchanged
|
} | ||
``` | ||
|
||
The above example is being translated with custom attribute transforms. For information on how we work with the `namespace.object.variant.property` hierarchical tree structure, check the transforms document. |
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.
Where can I find the transforms document?
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.
Aha, good that you ask, because I had the same question. I decided I would look for it later. Turns out, apparently, it doesn't exist… and is the "magic" that I feel is undocumented. I just forgot to remove this line here…
I feel we can link to the transforms documentation from Style Dictionary for now. But I argue that we should have more internal documentation about this (it will be tough to write and to read, though…)
a106a44
to
2c2682c
Compare
e13809f
to
75cbfed
Compare
Deploying orbit with Cloudflare Pages
|
75cbfed
to
a15741c
Compare
a15741c
to
10c48ac
Compare
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.
Key Issues
The onClick
handler is redundantly called twice, potentially causing double event handling. The change from pt-[52px]
to pt-1300
may lead to layout issues if the design token does not match the intended padding, and reordering of classes could affect CSS specificity and cascade.
The updated documentation focus on:
I would recommend the exercise of trying to add a token by reading the documentation.
I feel there is still some (a lot) "magic" going on during the build phase, with the transforms and output files generated. In case we decide to have documentation for that, it is very much for internal usage only (even more than tokens). So I felt it a bit out of scope for this task, although I do feel it is necessary, for future repository maintainers.
FEPLT-2094
✨
Description by Callstackai
This PR improves the documentation for tokens by clarifying the structure, providing examples, and removing unnecessary prose.
Diagrams of code changes
Files Changed
This PR includes files in programming languages that we currently do not support. We have not reviewed files with the extensions
.md
. See list of supported languages.