{"action":"created","issue":{"url":"https://api.github.com/repos/Mindwerks/worldengine/issues/166","labels_url":"https://api.github.com/repos/Mindwerks/worldengine/issues/166/labels{/name}","comments_url":"https://api.github.com/repos/Mindwerks/worldengine/issues/166/comments","events_url":"https://api.github.com/repos/Mindwerks/worldengine/issues/166/events","html_url":"https://github.com/Mindwerks/worldengine/issues/166","id":114400636,"number":166,"title":"Improving documentation","user":{"login":"ftomassetti","id":439078,"avatar_url":"https://avatars.githubusercontent.com/u/439078?v=3","gravatar_id":"","url":"https://api.github.com/users/ftomassetti","html_url":"https://github.com/ftomassetti","followers_url":"https://api.github.com/users/ftomassetti/followers","following_url":"https://api.github.com/users/ftomassetti/following{/other_user}","gists_url":"https://api.github.com/users/ftomassetti/gists{/gist_id}","starred_url":"https://api.github.com/users/ftomassetti/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ftomassetti/subscriptions","organizations_url":"https://api.github.com/users/ftomassetti/orgs","repos_url":"https://api.github.com/users/ftomassetti/repos","events_url":"https://api.github.com/users/ftomassetti/events{/privacy}","received_events_url":"https://api.github.com/users/ftomassetti/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":5,"created_at":"2015-10-31T09:40:03Z","updated_at":"2015-11-02T12:22:31Z","closed_at":null,"body":"In this issue we could discuss how to improve documentation. I think it could be also a good exercise to take a step back and look at the global picture so that we can shape how we want version 1.0 to be.\r\n\r\nI would suggest to use readthedocs: https://readthedocs.org/. To use it we should create a directory containing documentation in a rst format (think of it as an alternative to Markdown) and a git hook will just take those documents, compile them and produce documentation which would be available under worldengine.readthedocs.org\r\n\r\nWhat do you think? @psi29a @esampson @tcld "},"comment":{"url":"https://api.github.com/repos/Mindwerks/worldengine/issues/comments/153001766","html_url":"https://github.com/Mindwerks/worldengine/issues/166#issuecomment-153001766","issue_url":"https://api.github.com/repos/Mindwerks/worldengine/issues/166","id":153001766,"user":{"login":"ftomassetti","id":439078,"avatar_url":"https://avatars.githubusercontent.com/u/439078?v=3","gravatar_id":"","url":"https://api.github.com/users/ftomassetti","html_url":"https://github.com/ftomassetti","followers_url":"https://api.github.com/users/ftomassetti/followers","following_url":"https://api.github.com/users/ftomassetti/following{/other_user}","gists_url":"https://api.github.com/users/ftomassetti/gists{/gist_id}","starred_url":"https://api.github.com/users/ftomassetti/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ftomassetti/subscriptions","organizations_url":"https://api.github.com/users/ftomassetti/orgs","repos_url":"https://api.github.com/users/ftomassetti/repos","events_url":"https://api.github.com/users/ftomassetti/events{/privacy}","received_events_url":"https://api.github.com/users/ftomassetti/received_events","type":"User","site_admin":false},"created_at":"2015-11-02T12:22:31Z","updated_at":"2015-11-02T12:22:31Z","body":"thanks @esampson that is appreciated. Perhaps we could try to have small PRs for the documentation and merge frequently so it is easier for everyone to contribute. Do you want me to setup readthedocs or do you want to do that?"}}