Clarify `theme` vs `varaint` terminology for design tokens
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 140
- Forks
- 100
- Avg merge
- 1h 3m
- Merged PRs (30d)
- 30
Description
The naming throughout documentation and configuration is quite confusing.
Using 2U's elm-theme as an example:
- Theme name:
elm - Avaliable variants:
light
However, the directory structure leads to the light variant tokens living in /tokens/src/themes/light, making it seem as though light is the name of the theme, with no connection to it being a variant.
To provide a better theme author experience, we should ensure the difference is clear.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the documentation and configuration references to theme and variant, using the linked elm-theme example and /tokens/src/themes/light structure as context. Clarify the distinction between a theme name and its variants throughout the affected guidance, and confirm that the resulting terminology makes the theme author workflow unambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- design, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100