{"action":"created","comment":{"url":"https://api.github.com/repos/amzn/style-dictionary/pulls/comments/234440360","pull_request_review_id":176085595,"id":234440360,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDIzNDQ0MDM2MA==","diff_hunk":"@@ -4,39 +4,10 @@ Here is what the build system is doing under the hood.\n \n ![build structure](assets/build-diagram.png)\n \n-## CLI\n-\n-1. The build system looks for a config file. By default it looks for config.json in the current directory, or you can specify the config path with the `-c --config` flag.\n-1. If there is an `includes` attribute in the config, it will take those JSON files and deep merge them into the `properties` object.\n-1. It then takes all the JSON files in the `source` attribute in the config and performs a deep merge onto the `properties` object.\n+1. The build system reads in a configuration\n+1. If there is an `includes` attribute in the config, it will take those files and deep merge them into the `properties` object\n+1. It takes all the JSON files in the `source` attribute in the config and performs a deep merge onto the `properties` object\n 1. Then it iterates over the platforms in the config and:\n-  1. Perform all transforms, in order, defined in the transforms attribute or transformGroup.\n-  1. Build all files defined in the files array\n-  1. Perform any actions defined in the actions attribute\n-\n-\n-## Node\n-\n-If you use this as a node module, the steps are slightly different, but the overall.\n-\n-1. When you call the [`extend`](api.md#extend) method, you can either pass it a path to a JSON or JS config file, or give it a plain object that has the configuration. This will perform steps 1-3 above.\n-1. Then you can now call `buildAllPlatforms` or other methods like `buildPlatform('scss')` or `exportPlatform('javascript')`. This is equivalent to step 4 above.\n-\n-```javascript\n-const StyleDictionary = require('style-dictionary');\n-\n-const styleDictionary = StyleDictionary.extend( 'config.json' );\n-// is equivalent to this:\n-// const styleDictionary = StyleDictionary.extend(\n-//   JSON.parse( fs.readFileSync( 'config.json' ) )\n-// )\n-\n-// You can also extend with an object\n-// const styleDictionary = StyleDictionary.extend({ /* config options */ });\n-\n-// This will perform step 3 above, for each platform:\n-// 1. Apply transforms\n-// 2. Build files\n-// 3. Perform actions\n-styleDictionary.buildAllPlatforms();\n-```\n+  1. Performs all transforms, in order, defined in the transforms attribute or transformGroup\n+  1. Builds all files defined in the files array\n+  1. Performs any actions defined in the actions attribute","path":"docs/build_process.md","position":38,"original_position":45,"commit_id":"beac58790976d41a5ed419c5e37c6c2de47cdf1e","original_commit_id":"3ac9e8e02f84bb91e20e170859c1903bad03d5ad","user":{"login":"didoo","id":686239,"node_id":"MDQ6VXNlcjY4NjIzOQ==","avatar_url":"https://avatars1.githubusercontent.com/u/686239?v=4","gravatar_id":"","url":"https://api.github.com/users/didoo","html_url":"https://github.com/didoo","followers_url":"https://api.github.com/users/didoo/followers","following_url":"https://api.github.com/users/didoo/following{/other_user}","gists_url":"https://api.github.com/users/didoo/gists{/gist_id}","starred_url":"https://api.github.com/users/didoo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/didoo/subscriptions","organizations_url":"https://api.github.com/users/didoo/orgs","repos_url":"https://api.github.com/users/didoo/repos","events_url":"https://api.github.com/users/didoo/events{/privacy}","received_events_url":"https://api.github.com/users/didoo/received_events","type":"User","site_admin":false},"body":"It works ok :)","created_at":"2018-11-18T11:38:08Z","updated_at":"2018-11-18T11:38:08Z","html_url":"https://github.com/amzn/style-dictionary/pull/198#discussion_r234440360","pull_request_url":"https://api.github.com/repos/amzn/style-dictionary/pulls/198","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/amzn/style-dictionary/pulls/comments/234440360"},"html":{"href":"https://github.com/amzn/style-dictionary/pull/198#discussion_r234440360"},"pull_request":{"href":"https://api.github.com/repos/amzn/style-dictionary/pulls/198"}},"in_reply_to_id":234404557},"pull_request":{"url":"https://api.github.com/repos/amzn/style-dictionary/pulls/198","id":231689828,"node_id":"MDExOlB1bGxSZXF1ZXN0MjMxNjg5ODI4","html_url":"https://github.com/amzn/style-dictionary/pull/198","diff_url":"https://github.com/amzn/style-dictionary/pull/198.diff","patch_url":"https://github.com/amzn/style-dictionary/pull/198.patch","issue_url":"https://api.github.com/repos/amzn/style-dictionary/issues/198","number":198,"state":"open","locked":false,"title":"New cut at documentation PR using current develop branch","user":{"login":"chazzmoney","id":2113376,"node_id":"MDQ6VXNlcjIxMTMzNzY=","avatar_url":"https://avatars1.githubusercontent.com/u/2113376?v=4","gravatar_id":"","url":"https://api.github.com/users/chazzmoney","html_url":"https://github.com/chazzmoney","followers_url":"https://api.github.com/users/chazzmoney/followers","following_url":"https://api.github.com/users/chazzmoney/following{/other_user}","gists_url":"https://api.github.com/users/chazzmoney/gists{/gist_id}","starred_url":"https://api.github.com/users/chazzmoney/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/chazzmoney/subscriptions","organizations_url":"https://api.github.com/users/chazzmoney/orgs","repos_url":"https://api.github.com/users/chazzmoney/repos","events_url":"https://api.github.com/users/chazzmoney/events{/privacy}","received_events_url":"https://api.github.com/users/chazzmoney/received_events","type":"User","site_admin":false},"body":"This is intended to replace #103. It is not intended to be a perfect or complete documentation update. The spirit is to get this in as quickly as possible and then add TODOs for any other documentation updates we want to do.\r\n\r\n@didoo and @dbanksdesign Please give this a look over. It is based off of the existing setup in the develop branch, avoiding all the conflicts and fixing up some of the TODOs in the other branch.\r\n\r\nI'd like to get this done and pulled before Wednesday next week.\r\n\r\nI'll add issues for any comments I can't handle directly in this PR and tackle them small and separately from there.\r\n\r\nBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.\r\n","created_at":"2018-11-17T00:17:32Z","updated_at":"2018-11-18T11:38:08Z","closed_at":null,"merged_at":null,"merge_commit_sha":"fff36fa756a73f52fbef8d3476563c14583d78c0","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/amzn/style-dictionary/pulls/198/commits","review_comments_url":"https://api.github.com/repos/amzn/style-dictionary/pulls/198/comments","review_comment_url":"https://api.github.com/repos/amzn/style-dictionary/pulls/comments{/number}","comments_url":"https://api.github.com/repos/amzn/style-dictionary/issues/198/comments","statuses_url":"https://api.github.com/repos/amzn/style-dictionary/statuses/beac58790976d41a5ed419c5e37c6c2de47cdf1e","head":{"label":"amzn:faster-doc-update","ref":"faster-doc-update","sha":"beac58790976d41a5ed419c5e37c6c2de47cdf1e","user":{"login":"amzn","id":8594673,"node_id":"MDEyOk9yZ2FuaXphdGlvbjg1OTQ2NzM=","avatar_url":"https://avatars1.githubusercontent.com/u/8594673?v=4","gravatar_id":"","url":"https://api.github.com/users/amzn","html_url":"https://github.com/amzn","followers_url":"https://api.github.com/users/amzn/followers","following_url":"https://api.github.com/users/amzn/following{/other_user}","gists_url":"https://api.github.com/users/amzn/gists{/gist_id}","starred_url":"https://api.github.com/users/amzn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/amzn/subscriptions","organizations_url":"https://api.github.com/users/amzn/orgs","repos_url":"https://api.github.com/users/amzn/repos","events_url":"https://api.github.com/users/amzn/events{/privacy}","received_events_url":"https://api.github.com/users/amzn/received_events","type":"Organization","site_admin":false},"repo":{"id":75121110,"node_id":"MDEwOlJlcG9zaXRvcnk3NTEyMTExMA==","name":"style-dictionary","full_name":"amzn/style-dictionary","private":false,"owner":{"login":"amzn","id":8594673,"node_id":"MDEyOk9yZ2FuaXphdGlvbjg1OTQ2NzM=","avatar_url":"https://avatars1.githubusercontent.com/u/8594673?v=4","gravatar_id":"","url":"https://api.github.com/users/amzn","html_url":"https://github.com/amzn","followers_url":"https://api.github.com/users/amzn/followers","following_url":"https://api.github.com/users/amzn/following{/other_user}","gists_url":"https://api.github.com/users/amzn/gists{/gist_id}","starred_url":"https://api.github.com/users/amzn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/amzn/subscriptions","organizations_url":"https://api.github.com/users/amzn/orgs","repos_url":"https://api.github.com/users/amzn/repos","events_url":"https://api.github.com/users/amzn/events{/privacy}","received_events_url":"https://api.github.com/users/amzn/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/amzn/style-dictionary","description":"A build system for creating cross-platform styles.","fork":false,"url":"https://api.github.com/repos/amzn/style-dictionary","forks_url":"https://api.github.com/repos/amzn/style-dictionary/forks","keys_url":"https://api.github.com/repos/amzn/style-dictionary/keys{/key_id}","collaborators_url":"https://api.github.com/repos/amzn/style-dictionary/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/amzn/style-dictionary/teams","hooks_url":"https://api.github.com/repos/amzn/style-dictionary/hooks","issue_events_url":"https://api.github.com/repos/amzn/style-dictionary/issues/events{/number}","events_url":"https://api.github.com/repos/amzn/style-dictionary/events","assignees_url":"https://api.github.com/repos/amzn/style-dictionary/assignees{/user}","branches_url":"https://api.github.com/repos/amzn/style-dictionary/branches{/branch}","tags_url":"https://api.github.com/repos/amzn/style-dictionary/tags","blobs_url":"https://api.github.com/repos/amzn/style-dictionary/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/amzn/style-dictionary/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/amzn/style-dictionary/git/refs{/sha}","trees_url":"https://api.github.com/repos/amzn/style-dictionary/git/trees{/sha}","statuses_url":"https://api.github.com/repos/amzn/style-dictionary/statuses/{sha}","languages_url":"https://api.github.com/repos/amzn/style-dictionary/languages","stargazers_url":"https://api.github.com/repos/amzn/style-dictionary/stargazers","contributors_url":"https://api.github.com/repos/amzn/style-dictionary/contributors","subscribers_url":"https://api.github.com/repos/amzn/style-dictionary/subscribers","subscription_url":"https://api.github.com/repos/amzn/style-dictionary/subscription","commits_url":"https://api.github.com/repos/amzn/style-dictionary/commits{/sha}","git_commits_url":"https://api.github.com/repos/amzn/style-dictionary/git/commits{/sha}","comments_url":"https://api.github.com/repos/amzn/style-dictionary/comments{/number}","issue_comment_url":"https://api.github.com/repos/amzn/style-dictionary/issues/comments{/number}","contents_url":"https://api.github.com/repos/amzn/style-dictionary/contents/{+path}","compare_url":"https://api.github.com/repos/amzn/style-dictionary/compare/{base}...{head}","merges_url":"https://api.github.com/repos/amzn/style-dictionary/merges","archive_url":"https://api.github.com/repos/amzn/style-dictionary/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/amzn/style-dictionary/downloads","issues_url":"https://api.github.com/repos/amzn/style-dictionary/issues{/number}","pulls_url":"https://api.github.com/repos/amzn/style-dictionary/pulls{/number}","milestones_url":"https://api.github.com/repos/amzn/style-dictionary/milestones{/number}","notifications_url":"https://api.github.com/repos/amzn/style-dictionary/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/amzn/style-dictionary/labels{/name}","releases_url":"https://api.github.com/repos/amzn/style-dictionary/releases{/id}","deployments_url":"https://api.github.com/repos/amzn/style-dictionary/deployments","created_at":"2016-11-29T20:53:51Z","updated_at":"2018-11-17T17:40:41Z","pushed_at":"2018-11-18T11:34:53Z","git_url":"git://github.com/amzn/style-dictionary.git","ssh_url":"git@github.com:amzn/style-dictionary.git","clone_url":"https://github.com/amzn/style-dictionary.git","svn_url":"https://github.com/amzn/style-dictionary","homepage":"https://amzn.github.io/style-dictionary/#/","size":2342,"stargazers_count":414,"watchers_count":414,"language":"JavaScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":51,"mirror_url":null,"archived":false,"open_issues_count":33,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0","node_id":"MDc6TGljZW5zZTI="},"forks":51,"open_issues":33,"watchers":414,"default_branch":"master"}},"base":{"label":"amzn:develop","ref":"develop","sha":"d80cbb3b4a885ed50b9637b334bc2c8a80347011","user":{"login":"amzn","id":8594673,"node_id":"MDEyOk9yZ2FuaXphdGlvbjg1OTQ2NzM=","avatar_url":"https://avatars1.githubusercontent.com/u/8594673?v=4","gravatar_id":"","url":"https://api.github.com/users/amzn","html_url":"https://github.com/amzn","followers_url":"https://api.github.com/users/amzn/followers","following_url":"https://api.github.com/users/amzn/following{/other_user}","gists_url":"https://api.github.com/users/amzn/gists{/gist_id}","starred_url":"https://api.github.com/users/amzn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/amzn/subscriptions","organizations_url":"https://api.github.com/users/amzn/orgs","repos_url":"https://api.github.com/users/amzn/repos","events_url":"https://api.github.com/users/amzn/events{/privacy}","received_events_url":"https://api.github.com/users/amzn/received_events","type":"Organization","site_admin":false},"repo":{"id":75121110,"node_id":"MDEwOlJlcG9zaXRvcnk3NTEyMTExMA==","name":"style-dictionary","full_name":"amzn/style-dictionary","private":false,"owner":{"login":"amzn","id":8594673,"node_id":"MDEyOk9yZ2FuaXphdGlvbjg1OTQ2NzM=","avatar_url":"https://avatars1.githubusercontent.com/u/8594673?v=4","gravatar_id":"","url":"https://api.github.com/users/amzn","html_url":"https://github.com/amzn","followers_url":"https://api.github.com/users/amzn/followers","following_url":"https://api.github.com/users/amzn/following{/other_user}","gists_url":"https://api.github.com/users/amzn/gists{/gist_id}","starred_url":"https://api.github.com/users/amzn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/amzn/subscriptions","organizations_url":"https://api.github.com/users/amzn/orgs","repos_url":"https://api.github.com/users/amzn/repos","events_url":"https://api.github.com/users/amzn/events{/privacy}","received_events_url":"https://api.github.com/users/amzn/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/amzn/style-dictionary","description":"A build system for creating cross-platform styles.","fork":false,"url":"https://api.github.com/repos/amzn/style-dictionary","forks_url":"https://api.github.com/repos/amzn/style-dictionary/forks","keys_url":"https://api.github.com/repos/amzn/style-dictionary/keys{/key_id}","collaborators_url":"https://api.github.com/repos/amzn/style-dictionary/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/amzn/style-dictionary/teams","hooks_url":"https://api.github.com/repos/amzn/style-dictionary/hooks","issue_events_url":"https://api.github.com/repos/amzn/style-dictionary/issues/events{/number}","events_url":"https://api.github.com/repos/amzn/style-dictionary/events","assignees_url":"https://api.github.com/repos/amzn/style-dictionary/assignees{/user}","branches_url":"https://api.github.com/repos/amzn/style-dictionary/branches{/branch}","tags_url":"https://api.github.com/repos/amzn/style-dictionary/tags","blobs_url":"https://api.github.com/repos/amzn/style-dictionary/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/amzn/style-dictionary/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/amzn/style-dictionary/git/refs{/sha}","trees_url":"https://api.github.com/repos/amzn/style-dictionary/git/trees{/sha}","statuses_url":"https://api.github.com/repos/amzn/style-dictionary/statuses/{sha}","languages_url":"https://api.github.com/repos/amzn/style-dictionary/languages","stargazers_url":"https://api.github.com/repos/amzn/style-dictionary/stargazers","contributors_url":"https://api.github.com/repos/amzn/style-dictionary/contributors","subscribers_url":"https://api.github.com/repos/amzn/style-dictionary/subscribers","subscription_url":"https://api.github.com/repos/amzn/style-dictionary/subscription","commits_url":"https://api.github.com/repos/amzn/style-dictionary/commits{/sha}","git_commits_url":"https://api.github.com/repos/amzn/style-dictionary/git/commits{/sha}","comments_url":"https://api.github.com/repos/amzn/style-dictionary/comments{/number}","issue_comment_url":"https://api.github.com/repos/amzn/style-dictionary/issues/comments{/number}","contents_url":"https://api.github.com/repos/amzn/style-dictionary/contents/{+path}","compare_url":"https://api.github.com/repos/amzn/style-dictionary/compare/{base}...{head}","merges_url":"https://api.github.com/repos/amzn/style-dictionary/merges","archive_url":"https://api.github.com/repos/amzn/style-dictionary/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/amzn/style-dictionary/downloads","issues_url":"https://api.github.com/repos/amzn/style-dictionary/issues{/number}","pulls_url":"https://api.github.com/repos/amzn/style-dictionary/pulls{/number}","milestones_url":"https://api.github.com/repos/amzn/style-dictionary/milestones{/number}","notifications_url":"https://api.github.com/repos/amzn/style-dictionary/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/amzn/style-dictionary/labels{/name}","releases_url":"https://api.github.com/repos/amzn/style-dictionary/releases{/id}","deployments_url":"https://api.github.com/repos/amzn/style-dictionary/deployments","created_at":"2016-11-29T20:53:51Z","updated_at":"2018-11-17T17:40:41Z","pushed_at":"2018-11-18T11:34:53Z","git_url":"git://github.com/amzn/style-dictionary.git","ssh_url":"git@github.com:amzn/style-dictionary.git","clone_url":"https://github.com/amzn/style-dictionary.git","svn_url":"https://github.com/amzn/style-dictionary","homepage":"https://amzn.github.io/style-dictionary/#/","size":2342,"stargazers_count":414,"watchers_count":414,"language":"JavaScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":51,"mirror_url":null,"archived":false,"open_issues_count":33,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0","node_id":"MDc6TGljZW5zZTI="},"forks":51,"open_issues":33,"watchers":414,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/amzn/style-dictionary/pulls/198"},"html":{"href":"https://github.com/amzn/style-dictionary/pull/198"},"issue":{"href":"https://api.github.com/repos/amzn/style-dictionary/issues/198"},"comments":{"href":"https://api.github.com/repos/amzn/style-dictionary/issues/198/comments"},"review_comments":{"href":"https://api.github.com/repos/amzn/style-dictionary/pulls/198/comments"},"review_comment":{"href":"https://api.github.com/repos/amzn/style-dictionary/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/amzn/style-dictionary/pulls/198/commits"},"statuses":{"href":"https://api.github.com/repos/amzn/style-dictionary/statuses/beac58790976d41a5ed419c5e37c6c2de47cdf1e"}},"author_association":"MEMBER"}}
{"actor":{"display_login":"didoo"}}