{"action":"created","issue":{"url":"https://api.github.com/repos/router5/router5/issues/71","repository_url":"https://api.github.com/repos/router5/router5","labels_url":"https://api.github.com/repos/router5/router5/issues/71/labels{/name}","comments_url":"https://api.github.com/repos/router5/router5/issues/71/comments","events_url":"https://api.github.com/repos/router5/router5/issues/71/events","html_url":"https://github.com/router5/router5/issues/71","id":169081961,"number":71,"title":"Documentation lacks a good overview.","user":{"login":"mik01aj","id":3027415,"avatar_url":"https://avatars.githubusercontent.com/u/3027415?v=3","gravatar_id":"","url":"https://api.github.com/users/mik01aj","html_url":"https://github.com/mik01aj","followers_url":"https://api.github.com/users/mik01aj/followers","following_url":"https://api.github.com/users/mik01aj/following{/other_user}","gists_url":"https://api.github.com/users/mik01aj/gists{/gist_id}","starred_url":"https://api.github.com/users/mik01aj/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mik01aj/subscriptions","organizations_url":"https://api.github.com/users/mik01aj/orgs","repos_url":"https://api.github.com/users/mik01aj/repos","events_url":"https://api.github.com/users/mik01aj/events{/privacy}","received_events_url":"https://api.github.com/users/mik01aj/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":9,"created_at":"2016-08-03T09:01:31Z","updated_at":"2016-09-20T21:37:45Z","closed_at":null,"body":"I'm reading the documentation and it's hard for me to understand where would router5 go in my app. In the simplest form, I understand the router as something that maps urls to states. But the introduction doesn't talk about this. Let me quote the very first sentence:\r\n\r\n> The main idea behind router5 is to treat routes like any other application data / state. \r\n\r\nOkay, cool, I expect a nice pure functional router. But then in another place I read that calling `.start()` will bind the router to the browser state. In my understanding, this contradicts the \"main idea\"!\r\n\r\nThen I see:\r\n\r\n> With router5 it is reversed: rather than the router updating the view, it is up to the view to listen / bind / subscribe to route changes in order to update itself.\r\n\r\nSo I suppose that the router has some internal state, and I can push URLs and listen to state changes. Right?\r\n\r\nI try to be constructive, and not just complain about the docs I didn't write. But the introduction would really, really benefit from a \"big picture\" overview. This can be one paragraph, or an example with 10 lines of code, that would explain the Router5's place within an app. (e.g. should my UI create a router, or will the router create my UI?)\r\n\r\nMaybe I'll even prepare one when I understand it better. ;)"},"comment":{"url":"https://api.github.com/repos/router5/router5/issues/comments/248442489","html_url":"https://github.com/router5/router5/issues/71#issuecomment-248442489","issue_url":"https://api.github.com/repos/router5/router5/issues/71","id":248442489,"user":{"login":"troch","id":1777517,"avatar_url":"https://avatars.githubusercontent.com/u/1777517?v=3","gravatar_id":"","url":"https://api.github.com/users/troch","html_url":"https://github.com/troch","followers_url":"https://api.github.com/users/troch/followers","following_url":"https://api.github.com/users/troch/following{/other_user}","gists_url":"https://api.github.com/users/troch/gists{/gist_id}","starred_url":"https://api.github.com/users/troch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/troch/subscriptions","organizations_url":"https://api.github.com/users/troch/orgs","repos_url":"https://api.github.com/users/troch/repos","events_url":"https://api.github.com/users/troch/events{/privacy}","received_events_url":"https://api.github.com/users/troch/received_events","type":"User","site_admin":false},"created_at":"2016-09-20T21:37:45Z","updated_at":"2016-09-20T21:37:45Z","body":"@jwoudenberg API reference is available again"}}
{"actor":{"display_login":"troch"}}