chore: add a versions overview to README, prevED prop for living draft #272
Conversation
✅ Deploy Preview for dtcg-tr ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
|
||
| Here's an overview of all of the published versions of this draft specification: | ||
|
|
||
| | name | url | date | |
There was a problem hiding this comment.
| | name | url | date | | |
| | Name | URL | Date | |
|
|
||
| | name | url | date | | ||
| | --------------- | ---------------------------------------- | ---------- | | ||
| | editors-draft/1 | first-editors-draft.tr.designtokens.org | 2021-09-23 | |
There was a problem hiding this comment.
| | editors-draft/1 | first-editors-draft.tr.designtokens.org | 2021-09-23 | | |
| | editors-draft/1 | [first-editors-draft.tr.designtokens.org](first-editors-draft.tr.designtokens.org) | 2021-09-23 | |
| | editors-draft/2 | second-editors-draft.tr.designtokens.org | 2022-06-14 | | ||
| | living-draft | tr.designtokens.org | 2025-04-18 | | ||
|
|
||
| > Note: tools can use the date as a version number to signify compliance. For example: `20250418`. |
There was a problem hiding this comment.
I’d prefer 2025-04-18 instead because it’s more readable, and also screenreaders can announce that better than an integer. Also, having a string has the bonus feature of allowing more than one version per day, e.g. 2024-04-18-pre1 (which, you never know—always good to have the option)
There was a problem hiding this comment.
I'm pretty agnostic here, but to add to the bikeshedding, 2024.04.18 might be read better and has the advantage of looking like a version number. you can add a .1, .2 to the end there to indicate more than one version per day.
See slack for versioning discussion.
Even if we don't have semver (because it's not really the way of doing things for W3C community group specs it seems), it would help if the living draft that's published on tr.designtokens.org had a backlink to the previous editor draft.
Furthermore, adding a versions overview at least to the README of this repo is useful for tools to see which versions there are, so they can more easily communicate to their users which version of the spec the tool is compliant with.