{"action":"created","issue":{"url":"https://api.github.com/repos/PistonDevelopers/conrod/issues/682","repository_url":"https://api.github.com/repos/PistonDevelopers/conrod","labels_url":"https://api.github.com/repos/PistonDevelopers/conrod/issues/682/labels{/name}","comments_url":"https://api.github.com/repos/PistonDevelopers/conrod/issues/682/comments","events_url":"https://api.github.com/repos/PistonDevelopers/conrod/issues/682/events","html_url":"https://github.com/PistonDevelopers/conrod/pull/682","id":128788071,"number":682,"title":"The Guide - Chapter 1 (also clean up README in favour of a table of contents that links to the guide)","user":{"login":"mitchmindtree","id":4587373,"avatar_url":"https://avatars.githubusercontent.com/u/4587373?v=3","gravatar_id":"","url":"https://api.github.com/users/mitchmindtree","html_url":"https://github.com/mitchmindtree","followers_url":"https://api.github.com/users/mitchmindtree/followers","following_url":"https://api.github.com/users/mitchmindtree/following{/other_user}","gists_url":"https://api.github.com/users/mitchmindtree/gists{/gist_id}","starred_url":"https://api.github.com/users/mitchmindtree/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mitchmindtree/subscriptions","organizations_url":"https://api.github.com/users/mitchmindtree/orgs","repos_url":"https://api.github.com/users/mitchmindtree/repos","events_url":"https://api.github.com/users/mitchmindtree/events{/privacy}","received_events_url":"https://api.github.com/users/mitchmindtree/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2016-01-26T10:47:15Z","updated_at":"2016-02-02T15:43:28Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/PistonDevelopers/conrod/pulls/682","html_url":"https://github.com/PistonDevelopers/conrod/pull/682","diff_url":"https://github.com/PistonDevelopers/conrod/pull/682.diff","patch_url":"https://github.com/PistonDevelopers/conrod/pull/682.patch"},"body":"~~**WIP - Do not merge**~~\r\n\r\nStarting work on #505.\r\n\r\nCurrently this PR implements The Guide within a new `guide` module in the src. This allows for rustdoc's rendered markdown, easy upload (travis is already setup to upload docs) and for testing examples using `cargo test`.\r\n\r\nWe should also consider using [mdbook](https://github.com/azerupi/mdBook) (the same markdown book that the rust book uses). It also integrates testing using rustdoc, however i'm not yet sure how to host this using travis. Will look into it."},"comment":{"url":"https://api.github.com/repos/PistonDevelopers/conrod/issues/comments/178644536","html_url":"https://github.com/PistonDevelopers/conrod/pull/682#issuecomment-178644536","issue_url":"https://api.github.com/repos/PistonDevelopers/conrod/issues/682","id":178644536,"user":{"login":"mitchmindtree","id":4587373,"avatar_url":"https://avatars.githubusercontent.com/u/4587373?v=3","gravatar_id":"","url":"https://api.github.com/users/mitchmindtree","html_url":"https://github.com/mitchmindtree","followers_url":"https://api.github.com/users/mitchmindtree/followers","following_url":"https://api.github.com/users/mitchmindtree/following{/other_user}","gists_url":"https://api.github.com/users/mitchmindtree/gists{/gist_id}","starred_url":"https://api.github.com/users/mitchmindtree/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mitchmindtree/subscriptions","organizations_url":"https://api.github.com/users/mitchmindtree/orgs","repos_url":"https://api.github.com/users/mitchmindtree/repos","events_url":"https://api.github.com/users/mitchmindtree/events{/privacy}","received_events_url":"https://api.github.com/users/mitchmindtree/received_events","type":"User","site_admin":false},"created_at":"2016-02-02T15:43:28Z","updated_at":"2016-02-02T15:43:28Z","body":"Okydoke, chapter 1 is pretty much complete and ready to go.\r\n\r\nI've replaced most of the README stuff with a more concise table of contents which links to various sections of The Guide.\r\n\r\nA lot of the guide is still yet to be implemented, however I think it's useful enough in its current state to be merged. Hopefully I'll get some more free time soon to complete the remaining chapters."}}