Re: [community-group] [RFC] Format specification (#1)

Pulling some ideas from JSON Schema:

- [`comment`](https://json-schema.org/draft/2019-09/json-schema-core.html#rfc.section.8.3):  To readers or maintainers of the file / token. When you are designing tokens themselves and need to mention something important, a note or technical documentation. Such as how it is produced from other tokens, etc.
- [`description`](https://json-schema.org/draft/2019-09/json-schema-validation.html#rfc.section.9.1):  To the end user, what this token expresses, simple explanation, readable from a design tool. Optionally a `title` perhaps for a humanised name? (Example: `news-font-size` could have title `News Font Size`)
- [`deprecated`](https://json-schema.org/draft/2019-09/json-schema-validation.html#rfc.section.9.3):  Same per @calebdwilliams recommendation. Boolean to indicate deprecation and removal in the future.


Another thought might be declaring `dependencies` and/or `dependents` of tokens.
But I feel that ought to be implicit with what we decide on for the method of token relationships with calculations/references to make it more declarative. Machines are good at finding out such relationships, humans might err. However humans are great at more declarative stuff, e.g. `font-size-200: font-size-100 * type-scale-multiplier`.

-- 
GitHub Notification of comment by Martin-Pitt
Please view or discuss this issue at https://github.com/design-tokens/community-group/issues/1#issuecomment-580725489 using your GitHub account

Received on Friday, 31 January 2020 13:05:19 UTC