{"action":"created","issue":{"url":"https://api.github.com/repos/codebuddiesdotorg/cb-v2-scratch/issues/72","repository_url":"https://api.github.com/repos/codebuddiesdotorg/cb-v2-scratch","labels_url":"https://api.github.com/repos/codebuddiesdotorg/cb-v2-scratch/issues/72/labels{/name}","comments_url":"https://api.github.com/repos/codebuddiesdotorg/cb-v2-scratch/issues/72/comments","events_url":"https://api.github.com/repos/codebuddiesdotorg/cb-v2-scratch/issues/72/events","html_url":"https://github.com/codebuddiesdotorg/cb-v2-scratch/issues/72","id":142187907,"number":72,"title":"Create Site Documentation for Future Contributors","user":{"login":"foxiae","id":15113564,"avatar_url":"https://avatars.githubusercontent.com/u/15113564?v=3","gravatar_id":"","url":"https://api.github.com/users/foxiae","html_url":"https://github.com/foxiae","followers_url":"https://api.github.com/users/foxiae/followers","following_url":"https://api.github.com/users/foxiae/following{/other_user}","gists_url":"https://api.github.com/users/foxiae/gists{/gist_id}","starred_url":"https://api.github.com/users/foxiae/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/foxiae/subscriptions","organizations_url":"https://api.github.com/users/foxiae/orgs","repos_url":"https://api.github.com/users/foxiae/repos","events_url":"https://api.github.com/users/foxiae/events{/privacy}","received_events_url":"https://api.github.com/users/foxiae/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/codebuddiesdotorg/cb-v2-scratch/labels/help%20wanted","name":"help wanted","color":"159818"},{"url":"https://api.github.com/repos/codebuddiesdotorg/cb-v2-scratch/labels/question","name":"question","color":"cc317c"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2016-03-20T18:15:20Z","updated_at":"2016-03-22T17:40:20Z","closed_at":null,"body":"To ensure the site is well-maintained, we should look into documenting code structure, design principle, user functionality, etc. \r\n\r\nFrom Slack, @lpatmo suggested a FAQ knowledge base, @adachiu suggested a style guide, and @William-R-Wilson suggested a code style guide (e.g., code organization/file structure, variable naming, tabbing).\r\n\r\n@distalx mentioned we could use `@comments` to generate documentation and other npm packages (e.g., https://www.npmjs.com/package/apidoc).\r\n\r\n@adachiu mentioned http://patternlab.io/ for design documentation.\r\n\r\nWhat documentation should we provide for future contributors? How should we go about it?"},"comment":{"url":"https://api.github.com/repos/codebuddiesdotorg/cb-v2-scratch/issues/comments/199928567","html_url":"https://github.com/codebuddiesdotorg/cb-v2-scratch/issues/72#issuecomment-199928567","issue_url":"https://api.github.com/repos/codebuddiesdotorg/cb-v2-scratch/issues/72","id":199928567,"user":{"login":"distalx","id":11193792,"avatar_url":"https://avatars.githubusercontent.com/u/11193792?v=3","gravatar_id":"","url":"https://api.github.com/users/distalx","html_url":"https://github.com/distalx","followers_url":"https://api.github.com/users/distalx/followers","following_url":"https://api.github.com/users/distalx/following{/other_user}","gists_url":"https://api.github.com/users/distalx/gists{/gist_id}","starred_url":"https://api.github.com/users/distalx/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/distalx/subscriptions","organizations_url":"https://api.github.com/users/distalx/orgs","repos_url":"https://api.github.com/users/distalx/repos","events_url":"https://api.github.com/users/distalx/events{/privacy}","received_events_url":"https://api.github.com/users/distalx/received_events","type":"User","site_admin":false},"created_at":"2016-03-22T17:40:20Z","updated_at":"2016-03-22T17:40:20Z","body":"This package might be useful for doc genaration.\r\nhttps://www.npmjs.com/package/meteor-jsdoc\r\n"}}