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.

Sign up for GitHub

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

Jump to bottom

Add deep documentation #19

Open
d01000100 opened this issue Mar 3, 2023 · 1 comment
Open

Add deep documentation #19

d01000100 opened this issue Mar 3, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation Epic priority:medium

Comments

@d01000100
Copy link
Owner

Add enough documentation about the token-engine for two different audiences:

  1. Users of the token-engine
  2. Developers and maintainers of the token-engine

The documentation for devs must explain how all the parts work and communicate to one another, explain scenarios on how the token-engine can be extended and give examples.
@d01000100 d01000100 added documentation Improvements or additions to documentation priority:medium labels Mar 6, 2023
@d01000100 d01000100 mentioned this issue Mar 6, 2023
Open
@d01000100 d01000100 added the Epic label Mar 6, 2023
@d01000100
Copy link
Owner Author

d01000100 commented Mar 21, 2023 •
edited
Loading

  • All the options on the config file
  • The default StyleDictionary config and how to edit it
  • What custom transformers and transform groups are we registering
  • Custom Formats we're registering (css-autocomplete)
  • Custom Platforms we're using and what transformers they're using
  • How do we process "Other" tokens from Tokens Studio

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation Epic priority:medium
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@d01000100