chore(docs): v3 docs update #617
Conversation
docs/build_process.md
Outdated
|
|
||
| ## Parsers | ||
|
|
||
| Starting in version 3.0, you can define custom parsers to parse property files. This allws you to define your property files in *any* language you like as long as you can write a parser for it. |
There was a problem hiding this comment.
This section needs to be filled out and linked to the properties.md page custom parser section
There was a problem hiding this comment.
build_process and architecture are 90% the same. Decided to remove build_process, open to renaming architecture build_process though if it makes more sense.
docs/config.md
Outdated
| ---- | ||
| ### Platform | ||
|
|
||
| A platform is a collection of configuration that tells Style Dictionary how to transform and format your style properties. You can have as many platforms as you need and you can name them anything, there are no restrictions. |
There was a problem hiding this comment.
A platform is a collection of configuration that tells Style Dictionary how to transform and format your style properties
This is a bit obtuse / hard to parse. I think what is missing is the (obvious) use of a platform?
Maybe something like: "A platform is a group of configuration settings that tells Style Dictionary how to properly transform and format your style properties for output to a specific platform".
Or something?
There was a problem hiding this comment.
Every time I read something about a "platform" here, I change it to "build target" in my head to better understand what it means. I have "multiple build targets" for the "Web platform", with Sass, CSS, JSON…
There was a problem hiding this comment.
Oh nice @nhoizey! I like "build target"
docs/parsers.md
Outdated
|
|
||
| A custom parser matches design token files based on a file path regular expression. It will get the contents of a file as a string and should return an object of the data. | ||
|
|
||
| Custom parsers can be used to keep design token files in YAML, but they can also be used to add extra metadata onto all properties before transforms are run or anything else you can think of modifying on the design tokens before transforms are run. |
There was a problem hiding this comment.
I think you are trying to share example use cases here, but this is hard to parse and a bit confusing.
There was a problem hiding this comment.
Hard to parse. Nice.
|
Great comments @chazzmoney |
…ructure and updating docs
dbanksdesign
changed the title
Issue #, if available: #571 #159 #605
Description of changes: WIP!
tokensandallTokensto the core internal data structure to be consistent with this change. This is purely additional,propertiesandallPropertiesstill exist and this should not break existing code. Moving forward examples should usetokensrather thanproperties.Discussion points:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.