{"action":"created","issue":{"url":"https://api.github.com/repos/letsencrypt/lets-encrypt-preview/issues/194","labels_url":"https://api.github.com/repos/letsencrypt/lets-encrypt-preview/issues/194/labels{/name}","comments_url":"https://api.github.com/repos/letsencrypt/lets-encrypt-preview/issues/194/comments","events_url":"https://api.github.com/repos/letsencrypt/lets-encrypt-preview/issues/194/events","html_url":"https://github.com/letsencrypt/lets-encrypt-preview/issues/194","id":55417425,"number":194,"title":"docs creation / reorganize","user":{"login":"ThomasWaldmann","id":356103,"avatar_url":"https://avatars.githubusercontent.com/u/356103?v=3","gravatar_id":"","url":"https://api.github.com/users/ThomasWaldmann","html_url":"https://github.com/ThomasWaldmann","followers_url":"https://api.github.com/users/ThomasWaldmann/followers","following_url":"https://api.github.com/users/ThomasWaldmann/following{/other_user}","gists_url":"https://api.github.com/users/ThomasWaldmann/gists{/gist_id}","starred_url":"https://api.github.com/users/ThomasWaldmann/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ThomasWaldmann/subscriptions","organizations_url":"https://api.github.com/users/ThomasWaldmann/orgs","repos_url":"https://api.github.com/users/ThomasWaldmann/repos","events_url":"https://api.github.com/users/ThomasWaldmann/events{/privacy}","received_events_url":"https://api.github.com/users/ThomasWaldmann/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-01-25T14:29:25Z","updated_at":"2015-01-25T14:58:06Z","closed_at":null,"body":"there are some docs on readthedocs, but currently only API docs, so non-developers looking there might be a bit disappointed.\r\n\r\nmy suggestion (and also I am offering to do it) is to move most of the README into the docs and only keep introductory information in the README.\r\n\r\nAbout documentation structure: I have thought through and optimized this for one of my other projects and would suggest to do it in a similar way to avoid redundancies, see http://nsupdateinfo.readthedocs.org/en/latest/intro.html and https://raw.githubusercontent.com/nsupdate-info/nsupdate.info/master/docs/intro.rst - you see that introduction chapter of the docs is just the README and the CHANGES from the toplevel dir included there.\r\n\r\nWhat do you think?"},"comment":{"url":"https://api.github.com/repos/letsencrypt/lets-encrypt-preview/issues/comments/71376139","html_url":"https://github.com/letsencrypt/lets-encrypt-preview/issues/194#issuecomment-71376139","issue_url":"https://api.github.com/repos/letsencrypt/lets-encrypt-preview/issues/194","id":71376139,"user":{"login":"kuba","id":106176,"avatar_url":"https://avatars.githubusercontent.com/u/106176?v=3","gravatar_id":"","url":"https://api.github.com/users/kuba","html_url":"https://github.com/kuba","followers_url":"https://api.github.com/users/kuba/followers","following_url":"https://api.github.com/users/kuba/following{/other_user}","gists_url":"https://api.github.com/users/kuba/gists{/gist_id}","starred_url":"https://api.github.com/users/kuba/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kuba/subscriptions","organizations_url":"https://api.github.com/users/kuba/orgs","repos_url":"https://api.github.com/users/kuba/repos","events_url":"https://api.github.com/users/kuba/events{/privacy}","received_events_url":"https://api.github.com/users/kuba/received_events","type":"User","site_admin":false},"created_at":"2015-01-25T14:58:06Z","updated_at":"2015-01-25T14:58:06Z","body":"I like it. Can we also have the same badges? :)"}}