community-group

community-group copied to clipboard

Hello,

First of all, a huge thank you to all the people who have contributed so far to this wonderful initiative. Being passionate about UI and standardization, I loved reading the second draft and I want to be part of the contributors by proposing some changes that I hope you will like.

Context

When I search for the term "metadata", I only have one result in section 3.2 "(Design) Token Properties".

Proposal

I think we should rename it to "Extensions"

What do you think about this?

Thanks in advance for your opinion!

That word "metadata" appears in the "Terminology" section to define what "token properties" are. It's not specifically referring to the $extensions property of a token, though you could place metadata in $extensions.

Thanks @TravisSpomer, I understand what you said. But apply metadata at the same level of "name", "value" and "description" is confusing. Maybe we could add it in the sentence juste above then bullet points to explain what you said that a token is a set of metadata. What do you think?

Thanks for the kind compliments and feedback, @lauthieb!

While @TravisSpomer is right that that section was meant to describe the concept of design tokens in general - so the mention of "metadata" there was just meant to say "other kinds of meradata besides type & description might be included in a token" - I do agree that it could be confusing and should be reworded.

Especially since we were once considering a $metadata property for groups in the spec. Even though that idea was rejected in the end, I've seen it mentioned since so we shouldn't be adding to the confusion! :-)

How about changing it to something like this:

Information associated with a token name

For example:

• Value
• Type
• Description

Other, additional metadata might also be included in a design token.

Would that clear things up?

That definitely looks better to me. How about something like "Tools and design systems that support this format can also extend the format to include additional properties and metadata for a design token." That might help answer the next question of "well, what kind of additional metadata?" that someone might ask.

💯 agree with you @c1rrus & @TravisSpomer! If @TravisSpomer proposition sounds good for you, I will write the PR :)

I've created a PR to address this: https://github.com/design-tokens/community-group/pull/176

Thanks @kevinmpowell, just approved it ✅