{"action":"created","issue":{"url":"https://api.github.com/repos/rackt/react-router/issues/2259","labels_url":"https://api.github.com/repos/rackt/react-router/issues/2259/labels{/name}","comments_url":"https://api.github.com/repos/rackt/react-router/issues/2259/comments","events_url":"https://api.github.com/repos/rackt/react-router/issues/2259/events","html_url":"https://github.com/rackt/react-router/issues/2259","id":111234946,"number":2259,"title":"React Router / History Documentation Site?","user":{"login":"damassi","id":236943,"avatar_url":"https://avatars.githubusercontent.com/u/236943?v=3","gravatar_id":"","url":"https://api.github.com/users/damassi","html_url":"https://github.com/damassi","followers_url":"https://api.github.com/users/damassi/followers","following_url":"https://api.github.com/users/damassi/following{/other_user}","gists_url":"https://api.github.com/users/damassi/gists{/gist_id}","starred_url":"https://api.github.com/users/damassi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/damassi/subscriptions","organizations_url":"https://api.github.com/users/damassi/orgs","repos_url":"https://api.github.com/users/damassi/repos","events_url":"https://api.github.com/users/damassi/events{/privacy}","received_events_url":"https://api.github.com/users/damassi/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/rackt/react-router/labels/discussion","name":"discussion","color":"5319e7"}],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":6,"created_at":"2015-10-13T17:59:00Z","updated_at":"2015-10-13T18:32:41Z","closed_at":"2015-10-13T18:32:41Z","body":"I know everyone is working really hard to get React Router 1.0 out and I don't mean to raise a touchy subject, but I wanted to ask if you plan on creating a new documentation site with the release. For people who have used React Router for a while, managing all of the conflicting web references to different versions is manageable (albeit painful), but I seriously pity new users to React or React Router who don't yet understand the concepts or how things should wire together between this library and `history` and React itself.  \r\n\r\nRight now, when looking around on the web, there are Stack Overflow issues pointing to other issues pointing to blog posts pointing to upgrade guides and then finally pointing back at the Github Repo to open and closed issues and then to a docs *folder* which can be very confusing to click through as its hard to see how things relate. I've found looking at the test suite the best approach to see how 1.0 now works, but again, many new users don't know this or are afraid to dig into library code. \r\n\r\nI've noticed that between last week and today a lot of the ambiguity has been removed from the API page -- no more TypeScript definitions, etc, and more use-case examples -- so that is a step in the right direction, but nothing can replace a formal docs site. I know GitBook was used for the Redux docs (which are fantastic), and this library was just released By rstacruz: http://docpress.github.io/, also for documentation. \r\n\r\nI'd be more than willing to contribute to the documentation effort if what you need is resources, but ever since the documentation site disappeared for History i'm not sure that its even on the roadmap anymore -- hence the reason I'm filing this issue. \r\n\r\n"},"comment":{"url":"https://api.github.com/repos/rackt/react-router/issues/comments/147805485","html_url":"https://github.com/rackt/react-router/issues/2259#issuecomment-147805485","issue_url":"https://api.github.com/repos/rackt/react-router/issues/2259","id":147805485,"user":{"login":"knowbody","id":3802023,"avatar_url":"https://avatars.githubusercontent.com/u/3802023?v=3","gravatar_id":"","url":"https://api.github.com/users/knowbody","html_url":"https://github.com/knowbody","followers_url":"https://api.github.com/users/knowbody/followers","following_url":"https://api.github.com/users/knowbody/following{/other_user}","gists_url":"https://api.github.com/users/knowbody/gists{/gist_id}","starred_url":"https://api.github.com/users/knowbody/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/knowbody/subscriptions","organizations_url":"https://api.github.com/users/knowbody/orgs","repos_url":"https://api.github.com/users/knowbody/repos","events_url":"https://api.github.com/users/knowbody/events{/privacy}","received_events_url":"https://api.github.com/users/knowbody/received_events","type":"User","site_admin":false},"created_at":"2015-10-13T18:32:41Z","updated_at":"2015-10-13T18:32:41Z","body":"I do agree, I'm not sure if the documentation is lacking anything at the moment. It's more that people seem to like to have the docs on a fancy colourful website."}}