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

Better documentation for CTI #571

Closed
dbanksdesign opened this issue Mar 18, 2021 · 1 comment
Closed

Better documentation for CTI #571

dbanksdesign opened this issue Mar 18, 2021 · 1 comment

Comments

@dbanksdesign
Copy link
Member

There is often questions about the CTI structure and which categories and types are available to use in the built-in transforms and formats. Let's update our documentation to better reflect the categories and types used by built-in transforms and formats.

For those wondering right now, here is a start:

  • color (none of the types below the color category are used to apply different transforms, a color is a color. These types are just generally used)
    • background
    • font
    • border
  • size
    • font
    • icon (icon and font types in the size category are important for distinguishing between using DP and SP units in Android)
    • padding
    • border
  • asset (used for images and font files)
  • content (used for strings)
    • icon (this is assuming you are using an icon font with specific unicode characters)
dbanksdesign added a commit that referenced this issue May 12, 2021
Fixes #571 #159 #605
* Renamed "style properties" to "design tokens"
    * Adding tokens and allTokens to the core internal data structure to be consistent with this change. This is purely additional, properties and allProperties still exist and this should not break existing code. Moving forward examples should use tokens rather than properties.
    * properties.md -> tokens.md
    * Adding more content in this doc page about:
        * All potential attributes #605
        * Default attributes Style Dictionary adds
        * More info on what categories the CTI currently supports #571
        * Information on file formats for token files, including JS modules #159, and custom parsers for token files
* Updated broken links (linking to "master" branch instead of "main")
* Updated the examples page with all new examples
* Added a page on custom parsers
* Added information about transitive transforms
* Removed "docs/build_process.md" in favor of "docs/architecture.md" because the content was mostly the same.
* Cleaned up configuration content
    * Updated language around config file formats and how to define the configuration
    * Added information about configuration attributes and separated it out into sections: top-level config attributes including customization, platform attributes, and file attributes, for readability
* Cleaning up some spacing and headers in markdown files
@dbanksdesign
Copy link
Member Author

This is fixed in 3.0!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant