{"action":"created","issue":{"url":"https://api.github.com/repos/NodeBB/NodeBB/issues/4750","repository_url":"https://api.github.com/repos/NodeBB/NodeBB","labels_url":"https://api.github.com/repos/NodeBB/NodeBB/issues/4750/labels{/name}","comments_url":"https://api.github.com/repos/NodeBB/NodeBB/issues/4750/comments","events_url":"https://api.github.com/repos/NodeBB/NodeBB/issues/4750/events","html_url":"https://github.com/NodeBB/NodeBB/issues/4750","id":159790518,"number":4750,"title":"API documentation","user":{"login":"jsumners","id":321201,"avatar_url":"https://avatars.githubusercontent.com/u/321201?v=3","gravatar_id":"","url":"https://api.github.com/users/jsumners","html_url":"https://github.com/jsumners","followers_url":"https://api.github.com/users/jsumners/followers","following_url":"https://api.github.com/users/jsumners/following{/other_user}","gists_url":"https://api.github.com/users/jsumners/gists{/gist_id}","starred_url":"https://api.github.com/users/jsumners/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jsumners/subscriptions","organizations_url":"https://api.github.com/users/jsumners/orgs","repos_url":"https://api.github.com/users/jsumners/repos","events_url":"https://api.github.com/users/jsumners/events{/privacy}","received_events_url":"https://api.github.com/users/jsumners/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":7,"created_at":"2016-06-11T19:42:11Z","updated_at":"2016-06-16T14:41:34Z","closed_at":null,"body":"It doesn't exist. Having to dig through source code that doesn't contain a single comment, much less some documentation headers, to try and figure out what would be necessary to write a plugin is a **major** turn off. Especially when the promoted \"hook\" interface's list of hooks simply links to a \"it's around here\" section of the source code. Great, that's where the source code defines the hook. What does it do? How do we use it? Another example is `middleware/cls.js` and the `socket` function. There is absolutely no instruction on how to use it.\r\n\r\nDocumentation isn't fun to write. But it's a necessity when you are building a platform upon which you expect others to build."},"comment":{"url":"https://api.github.com/repos/NodeBB/NodeBB/issues/comments/226505984","html_url":"https://github.com/NodeBB/NodeBB/issues/4750#issuecomment-226505984","issue_url":"https://api.github.com/repos/NodeBB/NodeBB/issues/4750","id":226505984,"user":{"login":"jsumners","id":321201,"avatar_url":"https://avatars.githubusercontent.com/u/321201?v=3","gravatar_id":"","url":"https://api.github.com/users/jsumners","html_url":"https://github.com/jsumners","followers_url":"https://api.github.com/users/jsumners/followers","following_url":"https://api.github.com/users/jsumners/following{/other_user}","gists_url":"https://api.github.com/users/jsumners/gists{/gist_id}","starred_url":"https://api.github.com/users/jsumners/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jsumners/subscriptions","organizations_url":"https://api.github.com/users/jsumners/orgs","repos_url":"https://api.github.com/users/jsumners/repos","events_url":"https://api.github.com/users/jsumners/events{/privacy}","received_events_url":"https://api.github.com/users/jsumners/received_events","type":"User","site_admin":false},"created_at":"2016-06-16T14:41:34Z","updated_at":"2016-06-16T14:41:34Z","body":"Food > text. Agreed.\r\n\r\nIn regard to the forums suggestion. I simply don't want to deal with yet another account. It looks like you guys have a Gitter channel, so maybe I'll drop by there for some questions. But, as you said, I'd rather just be able to read the docs."}}
{"actor":{"display_login":"jsumners"}}