{"action":"created","issue":{"url":"https://api.github.com/repos/stach/functions.js/issues/1","repository_url":"https://api.github.com/repos/stach/functions.js","labels_url":"https://api.github.com/repos/stach/functions.js/issues/1/labels{/name}","comments_url":"https://api.github.com/repos/stach/functions.js/issues/1/comments","events_url":"https://api.github.com/repos/stach/functions.js/issues/1/events","html_url":"https://github.com/stach/functions.js/issues/1","id":284458708,"number":1,"title":"The content","user":{"login":"theIYD","id":10477827,"avatar_url":"https://avatars1.githubusercontent.com/u/10477827?v=4","gravatar_id":"","url":"https://api.github.com/users/theIYD","html_url":"https://github.com/theIYD","followers_url":"https://api.github.com/users/theIYD/followers","following_url":"https://api.github.com/users/theIYD/following{/other_user}","gists_url":"https://api.github.com/users/theIYD/gists{/gist_id}","starred_url":"https://api.github.com/users/theIYD/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/theIYD/subscriptions","organizations_url":"https://api.github.com/users/theIYD/orgs","repos_url":"https://api.github.com/users/theIYD/repos","events_url":"https://api.github.com/users/theIYD/events{/privacy}","received_events_url":"https://api.github.com/users/theIYD/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":5,"created_at":"2017-12-25T16:33:18Z","updated_at":"2017-12-26T14:10:04Z","closed_at":null,"author_association":"COLLABORATOR","body":"First of all, i want to Thank you for the **Christmas Surprise**  to make an effort to build a documentation Github Page for functions.js. I hope you loved the small library. \r\n\r\nTalking about the content, we need a minimalistic, simple and clean documentation which does not simply confuse the user who is reading it. \r\n\r\nA sample heirarchy might be like below: \r\n\r\n- **Function name**\r\nHere goes the function name with the actual implemented one & the one user is going to use it. \r\n\r\n- **Arguments** \r\nHere the argument names with their types will come. (Actually, in JSDocs of the functions, i have forgotten to define their types, although for now it might be empty. But that will be included in v1.4.0.)\r\n\r\n- **Description** \r\nNow this is the most **important**  part. The description must be more elaborated and more descriptive compared to the one liners in the Github Repo Methods Table. I know it will be difficult, but i will be helping you to build this together. I want the user to understand the funciton and let him go easy on this. \r\n\r\n- **Return type** \r\nHere goes the return types, what does the function return after it executes. \r\n\r\n- **Examples** \r\nHere, 2 to 3 unique examples of the function. \r\n\r\n**EDIT1:** \r\n\r\n- The website should be **responsive** on mobile and tab devices.\r\n- The column wise approach of dsiplaying the data would not work as the description is going to be elaborated. Maybe a **card-like** structure would resolve the problem. \r\n\r\nSo this might be the standard of each and every function. \r\n\r\nThe homepage might be minimalistic and impressing to the user. Animations are a plus point. \r\n\r\nPlease let me know a social contact so that i could talk to you more. \r\n\r\nThanks again for the effort 😀😊 @stach. "},"comment":{"url":"https://api.github.com/repos/stach/functions.js/issues/comments/353972766","html_url":"https://github.com/stach/functions.js/issues/1#issuecomment-353972766","issue_url":"https://api.github.com/repos/stach/functions.js/issues/1","id":353972766,"user":{"login":"theIYD","id":10477827,"avatar_url":"https://avatars1.githubusercontent.com/u/10477827?v=4","gravatar_id":"","url":"https://api.github.com/users/theIYD","html_url":"https://github.com/theIYD","followers_url":"https://api.github.com/users/theIYD/followers","following_url":"https://api.github.com/users/theIYD/following{/other_user}","gists_url":"https://api.github.com/users/theIYD/gists{/gist_id}","starred_url":"https://api.github.com/users/theIYD/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/theIYD/subscriptions","organizations_url":"https://api.github.com/users/theIYD/orgs","repos_url":"https://api.github.com/users/theIYD/repos","events_url":"https://api.github.com/users/theIYD/events{/privacy}","received_events_url":"https://api.github.com/users/theIYD/received_events","type":"User","site_admin":false},"created_at":"2017-12-26T14:10:04Z","updated_at":"2017-12-26T14:10:04Z","author_association":"COLLABORATOR","body":"I will write the descriptions for all the functions in a new few days. \r\n\r\nConsidering the above data flow, let the category go below the function name. Also, a table would not be the perfect UI to display all the functions. A **card-like** structure might do the work. \r\n\r\nThanks @stach "}}
{"actor":{"display_login":"theIYD"}}