-
Notifications
You must be signed in to change notification settings - Fork 8
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
chore: Write README for tokens package #1655
Conversation
Nice work! |
6650c3e
to
9473173
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.
I’ve rewritten it quire a bit.
Note that we have a mixed audience here:
- people creating components within the design system
- people creating custom components with different tech
- people using the tokens in a Saas-like application
I don’t mention this explicitly, but I did try to address these needs while keeping things short.
The first group shouldn't really be the audience of this README, I think? That should go in CONTRIBUTING.md. This should only be for consumers. |
Co-authored-by: Aram <[email protected]>
Describe the pull request
What
It documents the tokens package.
Why
The fact that it was still empty appeared glaringly evident in the
package.json
of a consuming application (developers.amsterdam).How
Wrote an initial version of it.
Checklist
Before submitting your pull request, please ensure you have done the following. Check each checkmark if you have done so or if it wasn't necessary:
Additional notes