{"action":"opened","issue":{"url":"https://api.github.com/repos/jacquetc/plume-creator/issues/7","repository_url":"https://api.github.com/repos/jacquetc/plume-creator","labels_url":"https://api.github.com/repos/jacquetc/plume-creator/issues/7/labels{/name}","comments_url":"https://api.github.com/repos/jacquetc/plume-creator/issues/7/comments","events_url":"https://api.github.com/repos/jacquetc/plume-creator/issues/7/events","html_url":"https://github.com/jacquetc/plume-creator/issues/7","id":158560683,"number":7,"title":"Discuss tools, formats for documentation","user":{"login":"ParaplegicRacehorse","id":7605896,"avatar_url":"https://avatars.githubusercontent.com/u/7605896?v=3","gravatar_id":"","url":"https://api.github.com/users/ParaplegicRacehorse","html_url":"https://github.com/ParaplegicRacehorse","followers_url":"https://api.github.com/users/ParaplegicRacehorse/followers","following_url":"https://api.github.com/users/ParaplegicRacehorse/following{/other_user}","gists_url":"https://api.github.com/users/ParaplegicRacehorse/gists{/gist_id}","starred_url":"https://api.github.com/users/ParaplegicRacehorse/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ParaplegicRacehorse/subscriptions","organizations_url":"https://api.github.com/users/ParaplegicRacehorse/orgs","repos_url":"https://api.github.com/users/ParaplegicRacehorse/repos","events_url":"https://api.github.com/users/ParaplegicRacehorse/events{/privacy}","received_events_url":"https://api.github.com/users/ParaplegicRacehorse/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/jacquetc/plume-creator/labels/question","name":"question","color":"cc317c"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":0,"created_at":"2016-06-05T15:52:26Z","updated_at":"2016-06-05T15:52:26Z","closed_at":null,"body":"A start on the documentation has been made with pull request #6\r\n\r\n@jacquetc, I looked through some of the code and ... I can't follow it well enough to write much in the way of a user manual. While I can document obvious features and how to get around the UI, any hidden technical gems, like keyboard shortcuts or command line arguments would get left out of the manual. As you continue to edit the source, would you place comments to help in this regard? Preferably something like [NaturalDocs](http://www.naturaldocs.org/) or [Asciidoclet](https://github.com/asciidoctor/asciidoclet). Having easy access to at least the technical documentation would help tremendously in writing a user manual. Also, code comments are good! :+1: \r\n\r\nAnd... you're probably going to have to be the guy who writes the plugin-authoring manual.\r\n\r\n**Potential documentation helpers**: It looks like using Plume to write the manual or even technical documents is not likely to work, at least not if it is to be easily handled by git and diff. I propose writing in Asciidoc or Markdown. Comments?\r\n\r\n"}}
{"actor":{"display_login":"ParaplegicRacehorse"}}