{"action":"opened","issue":{"url":"https://api.github.com/repos/JuliaPOMDP/POMDPs.jl/issues/205","repository_url":"https://api.github.com/repos/JuliaPOMDP/POMDPs.jl","labels_url":"https://api.github.com/repos/JuliaPOMDP/POMDPs.jl/issues/205/labels{/name}","comments_url":"https://api.github.com/repos/JuliaPOMDP/POMDPs.jl/issues/205/comments","events_url":"https://api.github.com/repos/JuliaPOMDP/POMDPs.jl/issues/205/events","html_url":"https://github.com/JuliaPOMDP/POMDPs.jl/issues/205","id":357338799,"node_id":"MDU6SXNzdWUzNTczMzg3OTk=","number":205,"title":"New documentation strategy","user":{"login":"zsunberg","id":4240491,"node_id":"MDQ6VXNlcjQyNDA0OTE=","avatar_url":"https://avatars3.githubusercontent.com/u/4240491?v=4","gravatar_id":"","url":"https://api.github.com/users/zsunberg","html_url":"https://github.com/zsunberg","followers_url":"https://api.github.com/users/zsunberg/followers","following_url":"https://api.github.com/users/zsunberg/following{/other_user}","gists_url":"https://api.github.com/users/zsunberg/gists{/gist_id}","starred_url":"https://api.github.com/users/zsunberg/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/zsunberg/subscriptions","organizations_url":"https://api.github.com/users/zsunberg/orgs","repos_url":"https://api.github.com/users/zsunberg/repos","events_url":"https://api.github.com/users/zsunberg/events{/privacy}","received_events_url":"https://api.github.com/users/zsunberg/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2018-09-05T17:56:22Z","updated_at":"2018-09-05T17:56:22Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"Now that things are more stable and we have broken things into smaller packages, I think it is time to up our documentation game.\r\n\r\nHere is my proposal:\r\n1. There should be an unregistered POMDPExamples package with many individual examples in ipython notebooks all in one place. There will be no tutorials hosted directly on POMDPs.jl\r\n  Notes:\r\n  - Some of these examples should be tutorials - however the tutorials should *only* cover POMDPs and *not* how to program in Julia; we should link to julia docs for that.\r\n  - We should run travis testing on these notebooks to ensure that they always work\r\n2. The components of each *registered* package should have appropriate docstrings, and individual documentation of each tool should be provided via Documenter.jl, however extended examples should be in POMDPExamples.jl\r\n3. Each *unregistered* package (e.g. solver) is responsible for it's own documentation with examples, etc. Minimum is one usage example and solver docstring that gives options. Documenter.jl is recommended but not required.\r\n\r\nAny comments?"}}
{"actor":{"display_login":"zsunberg"}}