Skip to content
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

Merged
merged 11 commits into from
Oct 16, 2024

Conversation

VincentSmedinga
Copy link
Contributor

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:

  • Add or update unit tests
  • Add or update documentation
  • Add or update stories
  • Add or update exports in index.* files
  • Start the PR title with a Conventional Commit prefix, as explained here.

Additional notes

  • Provide links to any related issues or discussions.
  • Add a link to the specific story in the feature branch deploy.
  • Mention any areas where additional review or feedback is needed.

proprietary/tokens/README.md Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
@alimpens
Copy link
Contributor

Nice work!

@VincentSmedinga VincentSmedinga force-pushed the docs/DES-982-tokens-package-readme branch from 6650c3e to 9473173 Compare October 15, 2024 15:37
@github-actions github-actions bot temporarily deployed to demo-DES-982-tokens-package-readme October 15, 2024 15:37 Destroyed
Copy link
Contributor Author

@VincentSmedinga VincentSmedinga left a 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.

proprietary/tokens/README.md Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to demo-DES-982-tokens-package-readme October 15, 2024 15:40 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-982-tokens-package-readme October 15, 2024 18:42 Destroyed
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Outdated Show resolved Hide resolved
proprietary/tokens/README.md Show resolved Hide resolved
proprietary/tokens/package.json Outdated Show resolved Hide resolved
@alimpens
Copy link
Contributor

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.

@github-actions github-actions bot temporarily deployed to demo-DES-982-tokens-package-readme October 16, 2024 08:11 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-982-tokens-package-readme October 16, 2024 08:14 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-982-tokens-package-readme October 16, 2024 09:27 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-982-tokens-package-readme October 16, 2024 10:12 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-982-tokens-package-readme October 16, 2024 10:42 Destroyed
@alimpens alimpens merged commit e64947a into develop Oct 16, 2024
6 checks passed
@alimpens alimpens deleted the docs/DES-982-tokens-package-readme branch October 16, 2024 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants