{"action":"created","issue":{"url":"https://api.github.com/repos/devtools-html/debugger.html/issues/701","repository_url":"https://api.github.com/repos/devtools-html/debugger.html","labels_url":"https://api.github.com/repos/devtools-html/debugger.html/issues/701/labels{/name}","comments_url":"https://api.github.com/repos/devtools-html/debugger.html/issues/701/comments","events_url":"https://api.github.com/repos/devtools-html/debugger.html/issues/701/events","html_url":"https://github.com/devtools-html/debugger.html/pull/701","id":175898472,"number":701,"title":"documentationjs for actions","user":{"login":"clarkbw","id":2134,"avatar_url":"https://avatars.githubusercontent.com/u/2134?v=3","gravatar_id":"","url":"https://api.github.com/users/clarkbw","html_url":"https://github.com/clarkbw","followers_url":"https://api.github.com/users/clarkbw/followers","following_url":"https://api.github.com/users/clarkbw/following{/other_user}","gists_url":"https://api.github.com/users/clarkbw/gists{/gist_id}","starred_url":"https://api.github.com/users/clarkbw/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/clarkbw/subscriptions","organizations_url":"https://api.github.com/users/clarkbw/orgs","repos_url":"https://api.github.com/users/clarkbw/repos","events_url":"https://api.github.com/users/clarkbw/events{/privacy}","received_events_url":"https://api.github.com/users/clarkbw/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":3,"created_at":"2016-09-09T00:31:23Z","updated_at":"2016-09-09T15:26:51Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/devtools-html/debugger.html/pulls/701","html_url":"https://github.com/devtools-html/debugger.html/pull/701","diff_url":"https://github.com/devtools-html/debugger.html/pull/701.diff","patch_url":"https://github.com/devtools-html/debugger.html/pull/701.patch"},"body":"**for discussion: not ready for merge**\r\n\r\nI did some initial work on auto-documenting the actions, you can see the actions doc here:\r\nhttps://github.com/clarkbw/debugger.html/blob/documentationjs/docs/actions.md\r\n\r\nThe goal was to help document out the actions as we merge in #629\r\n\r\nThis uses http://documentation.js.org/ which understands the Flow type and uses that to generate the `params`.  I reviewed jsdoc and a couple other solutions, most of which don't understand Flow or generate Flow from jsdoc which is not what we want.\r\n\r\nThe command to build out the actions looks like this: \r\n`documentation.js build -f md -o docs/actions.md public/js/actions/ -g`\r\n\r\nI think we would move that into something like `npm run doc-actions`\r\n\r\nYou can also run with a watch flag that updates as you document:\r\n`node_modules/documentation/bin/documentation.js build -f md -o docs/actions.md public/js/actions/ -g -w`\r\n\r\nThere are also HTML versions that can be built if we don't want Markdown."},"comment":{"url":"https://api.github.com/repos/devtools-html/debugger.html/issues/comments/245946785","html_url":"https://github.com/devtools-html/debugger.html/pull/701#issuecomment-245946785","issue_url":"https://api.github.com/repos/devtools-html/debugger.html/issues/701","id":245946785,"user":{"login":"jasonLaster","id":254562,"avatar_url":"https://avatars.githubusercontent.com/u/254562?v=3","gravatar_id":"","url":"https://api.github.com/users/jasonLaster","html_url":"https://github.com/jasonLaster","followers_url":"https://api.github.com/users/jasonLaster/followers","following_url":"https://api.github.com/users/jasonLaster/following{/other_user}","gists_url":"https://api.github.com/users/jasonLaster/gists{/gist_id}","starred_url":"https://api.github.com/users/jasonLaster/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jasonLaster/subscriptions","organizations_url":"https://api.github.com/users/jasonLaster/orgs","repos_url":"https://api.github.com/users/jasonLaster/repos","events_url":"https://api.github.com/users/jasonLaster/events{/privacy}","received_events_url":"https://api.github.com/users/jasonLaster/received_events","type":"User","site_admin":false},"created_at":"2016-09-09T15:26:51Z","updated_at":"2016-09-09T15:26:51Z","body":"* I'd like a way to note private functions.\r\n* is there a good way to split it up by file so that each set of actions `pause`, `breakpoints` is grouped"}}
{"actor":{"display_login":"jasonLaster"}}