{"action":"created","issue":{"url":"https://api.github.com/repos/jupyter/nbgrader/issues/414","repository_url":"https://api.github.com/repos/jupyter/nbgrader","labels_url":"https://api.github.com/repos/jupyter/nbgrader/issues/414/labels{/name}","comments_url":"https://api.github.com/repos/jupyter/nbgrader/issues/414/comments","events_url":"https://api.github.com/repos/jupyter/nbgrader/issues/414/events","html_url":"https://github.com/jupyter/nbgrader/pull/414","id":104771057,"number":414,"title":"Restructure user guide TOC and doc flow to support new users","user":{"login":"willingc","id":2680980,"avatar_url":"https://avatars.githubusercontent.com/u/2680980?v=3","gravatar_id":"","url":"https://api.github.com/users/willingc","html_url":"https://github.com/willingc","followers_url":"https://api.github.com/users/willingc/followers","following_url":"https://api.github.com/users/willingc/following{/other_user}","gists_url":"https://api.github.com/users/willingc/gists{/gist_id}","starred_url":"https://api.github.com/users/willingc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/willingc/subscriptions","organizations_url":"https://api.github.com/users/willingc/orgs","repos_url":"https://api.github.com/users/willingc/repos","events_url":"https://api.github.com/users/willingc/events{/privacy}","received_events_url":"https://api.github.com/users/willingc/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/jupyter/nbgrader/labels/docs","name":"docs","color":"fbca04"}],"state":"closed","locked":false,"assignee":null,"milestone":{"url":"https://api.github.com/repos/jupyter/nbgrader/milestones/6","html_url":"https://github.com/jupyter/nbgrader/milestones/0.3.0","labels_url":"https://api.github.com/repos/jupyter/nbgrader/milestones/6/labels","id":1259490,"number":6,"title":"0.3.0","description":"","creator":{"login":"jhamrick","id":83444,"avatar_url":"https://avatars.githubusercontent.com/u/83444?v=3","gravatar_id":"","url":"https://api.github.com/users/jhamrick","html_url":"https://github.com/jhamrick","followers_url":"https://api.github.com/users/jhamrick/followers","following_url":"https://api.github.com/users/jhamrick/following{/other_user}","gists_url":"https://api.github.com/users/jhamrick/gists{/gist_id}","starred_url":"https://api.github.com/users/jhamrick/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jhamrick/subscriptions","organizations_url":"https://api.github.com/users/jhamrick/orgs","repos_url":"https://api.github.com/users/jhamrick/repos","events_url":"https://api.github.com/users/jhamrick/events{/privacy}","received_events_url":"https://api.github.com/users/jhamrick/received_events","type":"User","site_admin":false},"open_issues":6,"closed_issues":41,"state":"open","created_at":"2015-08-17T22:28:49Z","updated_at":"2016-03-03T13:32:31Z","due_on":null,"closed_at":null},"comments":9,"created_at":"2015-09-03T20:04:14Z","updated_at":"2016-03-03T13:33:43Z","closed_at":"2016-03-03T13:32:31Z","pull_request":{"url":"https://api.github.com/repos/jupyter/nbgrader/pulls/414","html_url":"https://github.com/jupyter/nbgrader/pull/414","diff_url":"https://github.com/jupyter/nbgrader/pull/414.diff","patch_url":"https://github.com/jupyter/nbgrader/pull/414.patch"},"body":"This PR addresses issue #392. The user guide will frequently be the first documentation read by those interested in trying out nbgrader. The user guide must explain the project and its use, empower the user to try installing nbgrader, and to guide an instructor toward using nbgrader in a course.\r\n\r\nThe User Guide table of contents is now broken up into logical subsections of 3-4 items per subsection to improve learning and comprehension for those new to nbgrader. Examples are now titled with the format \"Workflow example: Instructor...\" or \"Workflow example: Student...\"\r\n\r\n\"Philosophy\" is modified to be a high level project and benefits overview.\r\nA new section for \"Interface highlights\" is added to share the user interface gifs that were recently added to the README.\r\nThere is a new section \"Recommended File Structure\" which contains the directory layout previously outlined in \"Philosophy\". \r\nThere is a new section for \"Installation\" using the information in the existing README.\r\n\r\nNew major heading of \"Managing assigments\" and \"Grading\" are added to the TOC.\r\n\r\nThere are still some markdown that needs to be converted to rst. Also the use of markdown on subsection titles such as for the Example in \"03_generating_assignments.ipynb\" is not elegant with Sphinx as configured and is not properly suppressing subtitles in Sphinx TOC for the docs. I will look into why.\r\n\r\n@jhamrick Thoughts? Not anchored to anything. Just want more useable docs for those new to using nbgrader. It also will be helpful to new developers for nbgrader, such as undergrad students, to have a solid overview and the info to get the project up and working."},"comment":{"url":"https://api.github.com/repos/jupyter/nbgrader/issues/comments/191762648","html_url":"https://github.com/jupyter/nbgrader/pull/414#issuecomment-191762648","issue_url":"https://api.github.com/repos/jupyter/nbgrader/issues/414","id":191762648,"user":{"login":"willingc","id":2680980,"avatar_url":"https://avatars.githubusercontent.com/u/2680980?v=3","gravatar_id":"","url":"https://api.github.com/users/willingc","html_url":"https://github.com/willingc","followers_url":"https://api.github.com/users/willingc/followers","following_url":"https://api.github.com/users/willingc/following{/other_user}","gists_url":"https://api.github.com/users/willingc/gists{/gist_id}","starred_url":"https://api.github.com/users/willingc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/willingc/subscriptions","organizations_url":"https://api.github.com/users/willingc/orgs","repos_url":"https://api.github.com/users/willingc/repos","events_url":"https://api.github.com/users/willingc/events{/privacy}","received_events_url":"https://api.github.com/users/willingc/received_events","type":"User","site_admin":false},"created_at":"2016-03-03T13:33:43Z","updated_at":"2016-03-03T13:33:43Z","body":"My pleasure. Education is near and dear to my heart @jhamrick  :-)"}}