{"action":"created","issue":{"url":"https://api.github.com/repos/rtfd/readthedocs.org/issues/4676","repository_url":"https://api.github.com/repos/rtfd/readthedocs.org","labels_url":"https://api.github.com/repos/rtfd/readthedocs.org/issues/4676/labels{/name}","comments_url":"https://api.github.com/repos/rtfd/readthedocs.org/issues/4676/comments","events_url":"https://api.github.com/repos/rtfd/readthedocs.org/issues/4676/events","html_url":"https://github.com/rtfd/readthedocs.org/pull/4676","id":365066389,"node_id":"MDExOlB1bGxSZXF1ZXN0MjE5MTA0MTY3","number":4676,"title":"Improve the getting started docs","user":{"login":"davidfischer","id":185043,"node_id":"MDQ6VXNlcjE4NTA0Mw==","avatar_url":"https://avatars3.githubusercontent.com/u/185043?v=4","gravatar_id":"","url":"https://api.github.com/users/davidfischer","html_url":"https://github.com/davidfischer","followers_url":"https://api.github.com/users/davidfischer/followers","following_url":"https://api.github.com/users/davidfischer/following{/other_user}","gists_url":"https://api.github.com/users/davidfischer/gists{/gist_id}","starred_url":"https://api.github.com/users/davidfischer/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/davidfischer/subscriptions","organizations_url":"https://api.github.com/users/davidfischer/orgs","repos_url":"https://api.github.com/users/davidfischer/repos","events_url":"https://api.github.com/users/davidfischer/events{/privacy}","received_events_url":"https://api.github.com/users/davidfischer/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":5,"created_at":"2018-09-28T22:55:34Z","updated_at":"2018-10-01T21:46:54Z","closed_at":null,"author_association":"CONTRIBUTOR","pull_request":{"url":"https://api.github.com/repos/rtfd/readthedocs.org/pulls/4676","html_url":"https://github.com/rtfd/readthedocs.org/pull/4676","diff_url":"https://github.com/rtfd/readthedocs.org/pull/4676.diff","patch_url":"https://github.com/rtfd/readthedocs.org/pull/4676.patch"},"body":"* Adds an introductory few paragraphs to `docs/index` page to explain the value proposition of Read the Docs. The goal here is to answer the \"Why Read the Docs\" question.\r\n* Breaks the getting started guide into 3 docs\r\n  - getting started with Sphinx\r\n  - getting started with MkDocs (this is brand new)\r\n  - importing your documentation\r\n* In the getting started with X guides, I briefly explain the benefits/trade-offs of using Sphinx/MkDocs\r\n* Puts \"connecting your account\" (to GitHub, Bitbucket, GitLab) into a separate doc rather than in the getting started guide. This won't be as necessary going forward as more people choose to sign up with GitHub, etc.\r\n* In the toctree, moves:\r\n  - the \"about Read the Docs\" section below \"Feature documentation\"\r\n  - puts the \"Design\" section into the developer documentation\r\n\r\n## After merging\r\n\r\nCreate a redirect in the Read the Docs project dashboard for the \"docs\" project from `getting-started.html` -> `intro/getting-started-with-sphinx.html`.\r\n\r\n## Notes\r\n\r\nI would like to put full sentence/paragraph descriptions on different sections (eg. User documentation, Feature documentation, About Read the Docs, etc.), but there isn't a great way to do this. I still think we should do it to explain the differences between those various sections. Currently the best path I have for that is similar to what I did with \"First steps\" which is to make the toctree hidden and then also have duplicate links to the documents.\r\n\r\nWhat are peoples' thoughts on having more screenshots in our docs? I put one in the import guide but I could easily create a lot more. I think especially in getting started guides, these are very reassuring and show people they are doing the right thing in the right place.\r\n\r\nFixes #4648"},"comment":{"url":"https://api.github.com/repos/rtfd/readthedocs.org/issues/comments/426074431","html_url":"https://github.com/rtfd/readthedocs.org/pull/4676#issuecomment-426074431","issue_url":"https://api.github.com/repos/rtfd/readthedocs.org/issues/4676","id":426074431,"node_id":"MDEyOklzc3VlQ29tbWVudDQyNjA3NDQzMQ==","user":{"login":"davidfischer","id":185043,"node_id":"MDQ6VXNlcjE4NTA0Mw==","avatar_url":"https://avatars3.githubusercontent.com/u/185043?v=4","gravatar_id":"","url":"https://api.github.com/users/davidfischer","html_url":"https://github.com/davidfischer","followers_url":"https://api.github.com/users/davidfischer/followers","following_url":"https://api.github.com/users/davidfischer/following{/other_user}","gists_url":"https://api.github.com/users/davidfischer/gists{/gist_id}","starred_url":"https://api.github.com/users/davidfischer/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/davidfischer/subscriptions","organizations_url":"https://api.github.com/users/davidfischer/orgs","repos_url":"https://api.github.com/users/davidfischer/repos","events_url":"https://api.github.com/users/davidfischer/events{/privacy}","received_events_url":"https://api.github.com/users/davidfischer/received_events","type":"User","site_admin":false},"created_at":"2018-10-01T21:46:54Z","updated_at":"2018-10-01T21:46:54Z","author_association":"CONTRIBUTOR","body":"The lint errors are due to search stuff, not these docs."}}
{"actor":{"display_login":"davidfischer"}}