{"action":"created","issue":{"url":"https://api.github.com/repos/dart-lang/dev_compiler/issues/613","repository_url":"https://api.github.com/repos/dart-lang/dev_compiler","labels_url":"https://api.github.com/repos/dart-lang/dev_compiler/issues/613/labels{/name}","comments_url":"https://api.github.com/repos/dart-lang/dev_compiler/issues/613/comments","events_url":"https://api.github.com/repos/dart-lang/dev_compiler/issues/613/events","html_url":"https://github.com/dart-lang/dev_compiler/issues/613","id":167991489,"number":613,"title":"Document usage","user":{"login":"nex3","id":188,"avatar_url":"https://avatars.githubusercontent.com/u/188?v=3","gravatar_id":"","url":"https://api.github.com/users/nex3","html_url":"https://github.com/nex3","followers_url":"https://api.github.com/users/nex3/followers","following_url":"https://api.github.com/users/nex3/following{/other_user}","gists_url":"https://api.github.com/users/nex3/gists{/gist_id}","starred_url":"https://api.github.com/users/nex3/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nex3/subscriptions","organizations_url":"https://api.github.com/users/nex3/orgs","repos_url":"https://api.github.com/users/nex3/repos","events_url":"https://api.github.com/users/nex3/events{/privacy}","received_events_url":"https://api.github.com/users/nex3/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/dart-lang/dev_compiler/labels/enhancement","name":"enhancement","color":"ededed"},{"url":"https://api.github.com/repos/dart-lang/dev_compiler/labels/P1%20high","name":"P1 high","color":"eb6420"},{"url":"https://api.github.com/repos/dart-lang/dev_compiler/labels/ux","name":"ux","color":"bfd4f2"}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":6,"created_at":"2016-07-28T01:07:54Z","updated_at":"2016-08-02T23:55:11Z","closed_at":null,"body":"Currently there's very little documentation describing how to use the dev compiler. [The usage doc](https://github.com/dart-lang/dev_compiler/blob/master/USAGE.md) that exists is very sparse and has been marked as out-of-date [for three months](https://github.com/dart-lang/dev_compiler/commit/e4f4ee01755c35cedddf86dee8d392256b54cb77).\r\n\r\nSome information that would be useful:\r\n\r\n* How to compile a simple application. In particular, it's not obvious that every source file needs to be provided explicitly.\r\n* How to use package imports.\r\n* What comprises a module—the relationship between the generated JS and the summary.\r\n* How to use a summary when compiling, and the benefit of doing so.\r\n* What the `--build-root` and `--module-root` flags do and when they're needed.\r\n* How to embed compiled JS into a web page, especially if the same page needs multiple modules.\r\n* How to choose which library's main method is invoked."},"comment":{"url":"https://api.github.com/repos/dart-lang/dev_compiler/issues/comments/237087061","html_url":"https://github.com/dart-lang/dev_compiler/issues/613#issuecomment-237087061","issue_url":"https://api.github.com/repos/dart-lang/dev_compiler/issues/613","id":237087061,"user":{"login":"vsmenon","id":2119553,"avatar_url":"https://avatars.githubusercontent.com/u/2119553?v=3","gravatar_id":"","url":"https://api.github.com/users/vsmenon","html_url":"https://github.com/vsmenon","followers_url":"https://api.github.com/users/vsmenon/followers","following_url":"https://api.github.com/users/vsmenon/following{/other_user}","gists_url":"https://api.github.com/users/vsmenon/gists{/gist_id}","starred_url":"https://api.github.com/users/vsmenon/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vsmenon/subscriptions","organizations_url":"https://api.github.com/users/vsmenon/orgs","repos_url":"https://api.github.com/users/vsmenon/repos","events_url":"https://api.github.com/users/vsmenon/events{/privacy}","received_events_url":"https://api.github.com/users/vsmenon/received_events","type":"User","site_admin":false},"created_at":"2016-08-02T23:55:10Z","updated_at":"2016-08-02T23:55:10Z","body":"Today, the module name is the relative path of the output js file (minus extension) wrt to the module_root.\r\n\r\nSimilarly, the library name is the relative path of the input library dart wrt to the library_root with the separator replaced by '__'.\r\n\r\nThis was setup to work with bazel rules."}}
{"actor":{"display_login":"vsmenon"}}