{"action":"created","issue":{"url":"https://api.github.com/repos/neomutt/neomutt/issues/166","repository_url":"https://api.github.com/repos/neomutt/neomutt","labels_url":"https://api.github.com/repos/neomutt/neomutt/issues/166/labels{/name}","comments_url":"https://api.github.com/repos/neomutt/neomutt/issues/166/comments","events_url":"https://api.github.com/repos/neomutt/neomutt/issues/166/events","html_url":"https://github.com/neomutt/neomutt/issues/166","id":179551643,"number":166,"title":"Problems with our user documentation and how we want to improve that.","user":{"login":"toogley","id":9417950,"avatar_url":"https://avatars.githubusercontent.com/u/9417950?v=3","gravatar_id":"","url":"https://api.github.com/users/toogley","html_url":"https://github.com/toogley","followers_url":"https://api.github.com/users/toogley/followers","following_url":"https://api.github.com/users/toogley/following{/other_user}","gists_url":"https://api.github.com/users/toogley/gists{/gist_id}","starred_url":"https://api.github.com/users/toogley/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/toogley/subscriptions","organizations_url":"https://api.github.com/users/toogley/orgs","repos_url":"https://api.github.com/users/toogley/repos","events_url":"https://api.github.com/users/toogley/events{/privacy}","received_events_url":"https://api.github.com/users/toogley/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/neomutt/neomutt/labels/discussion","name":"discussion","color":"9f00bf"},{"url":"https://api.github.com/repos/neomutt/neomutt/labels/docs","name":"docs","color":"990000"},{"url":"https://api.github.com/repos/neomutt/neomutt/labels/enhancement","name":"enhancement","color":"fbca04"},{"url":"https://api.github.com/repos/neomutt/neomutt/labels/priority:high","name":"priority:high","color":"fb9a94"}],"state":"open","locked":false,"assignee":{"login":"toogley","id":9417950,"avatar_url":"https://avatars.githubusercontent.com/u/9417950?v=3","gravatar_id":"","url":"https://api.github.com/users/toogley","html_url":"https://github.com/toogley","followers_url":"https://api.github.com/users/toogley/followers","following_url":"https://api.github.com/users/toogley/following{/other_user}","gists_url":"https://api.github.com/users/toogley/gists{/gist_id}","starred_url":"https://api.github.com/users/toogley/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/toogley/subscriptions","organizations_url":"https://api.github.com/users/toogley/orgs","repos_url":"https://api.github.com/users/toogley/repos","events_url":"https://api.github.com/users/toogley/events{/privacy}","received_events_url":"https://api.github.com/users/toogley/received_events","type":"User","site_admin":false},"assignees":[{"login":"toogley","id":9417950,"avatar_url":"https://avatars.githubusercontent.com/u/9417950?v=3","gravatar_id":"","url":"https://api.github.com/users/toogley","html_url":"https://github.com/toogley","followers_url":"https://api.github.com/users/toogley/followers","following_url":"https://api.github.com/users/toogley/following{/other_user}","gists_url":"https://api.github.com/users/toogley/gists{/gist_id}","starred_url":"https://api.github.com/users/toogley/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/toogley/subscriptions","organizations_url":"https://api.github.com/users/toogley/orgs","repos_url":"https://api.github.com/users/toogley/repos","events_url":"https://api.github.com/users/toogley/events{/privacy}","received_events_url":"https://api.github.com/users/toogley/received_events","type":"User","site_admin":false}],"milestone":null,"comments":9,"created_at":"2016-09-27T16:56:42Z","updated_at":"2016-10-05T18:41:43Z","closed_at":null,"body":"Hey.\r\n\r\nour documentation (=the stuff on neomutt.org and on our github, but **not** the comments in the code) is currently highly fragmented.\r\n\r\n## The Problem\r\n\r\n#### files inside neomutt repo \r\n\r\n* Small [muttrc.$feature](https://github.com/neomutt/neomutt/blob/neomutt/doc/muttrc.compose-to-sender) files, which document the mutt config of a specific feature.\r\n* [a huge manual.xml.head](https://github.com/neomutt/neomutt/blob/neomutt/doc/manual.xml.head) which consists - if i understood it correctly - of parts of the old upstream manual and some additions from us. That's very confusing, at least for me.\r\n* [We](https://github.com/neomutt/neomutt/blob/neomutt/README.SSL)  [have](https://github.com/neomutt/neomutt/blob/neomutt/README.notmuch) multiple [README](https://github.com/neomutt/neomutt/blob/neomutt/README.neomutt) [files](https://github.com/neomutt/neomutt/blob/neomutt/README).\r\n\r\n#### repo of our website\r\n\r\n* the whole [repo of our website](https://github.com/neomutt/neomutt.github.io), which in turn holds some [things which are not included in the main repo](https://github.com/neomutt/neomutt.github.io/tree/master/devel) and [some](https://github.com/neomutt/neomutt.github.io/blob/master/_contrib/vim-keybindings.md) [files](https://github.com/neomutt/neomutt/tree/neomutt/contrib/vim-keybindings) with kind of conflicting content.\r\n\r\n#### our neomutt repo wiki\r\n\r\n* [this wiki page](https://github.com/neomutt/neomutt/wiki/Blue-Sky-Ideas) is a duplicate of [parts of the website](https://www.neomutt.org/devel/). The wiki page is more updated than the website\r\n* [this wiki page](https://github.com/neomutt/neomutt/wiki) is a duplicate of [the parts of the website](https://www.neomutt.org/). There, the website is more accurate, we have now also a devel mailinglist.\r\n\r\n** Note**: I created a separate [Issue](https://github.com/neomutt/neomutt/issues/177) for that.\r\n\r\n## Questions\r\n\r\n* What do you not like about our documentation?\r\n* How should we handle[ upstream docs](https://dev.mutt.org/trac/wiki/MuttGuide)? \r\n* Currently, we write our docs in html and the language of the mutt manual (i don't know what its called)\r\n    - are there things which are cumbersome/difficult to do with one of them?\r\n    - what language do we want to use for writing docs?\r\n* Do you have ideas on how we could improve?\r\n* in which repo should we save our documentation?\r\n* Do we like that our docs are build with a makefile? are there better alternatives?\r\n* What should the purpose of our wiki be? Do we need it at all?\r\n    - As much of the wiki is essential a obsolete/updated copy of something else - maybe we should edit only on one place and build the wiki with a script?\r\n    - Originally, @flatcap and I thought the wiki should be the place for kind of \"ideas\" and such things. But currently, i consider the github issues/mailinglist better suited for that - we have tags (and later maybe milestones) there and can therefore organize it better."},"comment":{"url":"https://api.github.com/repos/neomutt/neomutt/issues/comments/251762202","html_url":"https://github.com/neomutt/neomutt/issues/166#issuecomment-251762202","issue_url":"https://api.github.com/repos/neomutt/neomutt/issues/166","id":251762202,"user":{"login":"pickfire","id":4687791,"avatar_url":"https://avatars.githubusercontent.com/u/4687791?v=3","gravatar_id":"","url":"https://api.github.com/users/pickfire","html_url":"https://github.com/pickfire","followers_url":"https://api.github.com/users/pickfire/followers","following_url":"https://api.github.com/users/pickfire/following{/other_user}","gists_url":"https://api.github.com/users/pickfire/gists{/gist_id}","starred_url":"https://api.github.com/users/pickfire/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pickfire/subscriptions","organizations_url":"https://api.github.com/users/pickfire/orgs","repos_url":"https://api.github.com/users/pickfire/repos","events_url":"https://api.github.com/users/pickfire/events{/privacy}","received_events_url":"https://api.github.com/users/pickfire/received_events","type":"User","site_admin":false},"created_at":"2016-10-05T18:41:43Z","updated_at":"2016-10-05T18:41:43Z","body":"@toogley I don't mean talking, I mean something like pair programming. Hoping to do one too but sadly I can't find anyone who is able to help."}}
{"actor":{"display_login":"pickfire"}}