{"action":"created","issue":{"url":"https://api.github.com/repos/rust-lang/cargo/issues/2580","repository_url":"https://api.github.com/repos/rust-lang/cargo","labels_url":"https://api.github.com/repos/rust-lang/cargo/issues/2580/labels{/name}","comments_url":"https://api.github.com/repos/rust-lang/cargo/issues/2580/comments","events_url":"https://api.github.com/repos/rust-lang/cargo/issues/2580/events","html_url":"https://github.com/rust-lang/cargo/issues/2580","id":148434848,"number":2580,"title":"Overhaul documentation","user":{"login":"alexcrichton","id":64996,"avatar_url":"https://avatars.githubusercontent.com/u/64996?v=3","gravatar_id":"","url":"https://api.github.com/users/alexcrichton","html_url":"https://github.com/alexcrichton","followers_url":"https://api.github.com/users/alexcrichton/followers","following_url":"https://api.github.com/users/alexcrichton/following{/other_user}","gists_url":"https://api.github.com/users/alexcrichton/gists{/gist_id}","starred_url":"https://api.github.com/users/alexcrichton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/alexcrichton/subscriptions","organizations_url":"https://api.github.com/users/alexcrichton/orgs","repos_url":"https://api.github.com/users/alexcrichton/repos","events_url":"https://api.github.com/users/alexcrichton/events{/privacy}","received_events_url":"https://api.github.com/users/alexcrichton/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/rust-lang/cargo/labels/docs","name":"docs","color":"009800"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":3,"created_at":"2016-04-14T17:44:53Z","updated_at":"2016-04-17T03:36:39Z","closed_at":null,"body":"There's a few banner things that we need to clean up about the Cargo documentation:\r\n\r\n* The look-and-feel is *very* different than the main documentation (e.g. the book). Probably unnecessarily so?\r\n* The organization is a little confusing today unfortunately. I've been told a few times that the content is all there, it's just not necessarily presented in a cohesive fashion that's easily queried.\r\n* Perhaps we should just migrate all of the documentation to the book itself? Cargo is such a core tool in Rust that we probably don't want to have such standalone and somewhat-difficult-to-find documentation.\r\n\r\ncc @steveklabnik, @brson, @aturon "},"comment":{"url":"https://api.github.com/repos/rust-lang/cargo/issues/comments/210947819","html_url":"https://github.com/rust-lang/cargo/issues/2580#issuecomment-210947819","issue_url":"https://api.github.com/repos/rust-lang/cargo/issues/2580","id":210947819,"user":{"login":"nodakai","id":90726,"avatar_url":"https://avatars.githubusercontent.com/u/90726?v=3","gravatar_id":"","url":"https://api.github.com/users/nodakai","html_url":"https://github.com/nodakai","followers_url":"https://api.github.com/users/nodakai/followers","following_url":"https://api.github.com/users/nodakai/following{/other_user}","gists_url":"https://api.github.com/users/nodakai/gists{/gist_id}","starred_url":"https://api.github.com/users/nodakai/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nodakai/subscriptions","organizations_url":"https://api.github.com/users/nodakai/orgs","repos_url":"https://api.github.com/users/nodakai/repos","events_url":"https://api.github.com/users/nodakai/events{/privacy}","received_events_url":"https://api.github.com/users/nodakai/received_events","type":"User","site_admin":false},"created_at":"2016-04-17T03:36:39Z","updated_at":"2016-04-17T03:36:39Z","body":"A tutorial guide should be split off from the reference document.\r\n\r\nThe tutorial could be written to match the learning curve of a typical newcomer, with an emphasis on how to get started with Cargo. We might actually want to have two tutorials (or part I and II?), one for a crate user and another for a crate writer.\r\n\r\nOn the other hand the reference should list up each and every command line option and config item in a hierarchical way with an accurate description of its semantics. Rustdoc of the `cargo` command itself might or might not serve for this purpose (just a rough idea.)"}}