{"action":"created","issue":{"url":"https://api.github.com/repos/perl6/modules.perl6.org/issues/16","labels_url":"https://api.github.com/repos/perl6/modules.perl6.org/issues/16/labels{/name}","comments_url":"https://api.github.com/repos/perl6/modules.perl6.org/issues/16/comments","events_url":"https://api.github.com/repos/perl6/modules.perl6.org/issues/16/events","html_url":"https://github.com/perl6/modules.perl6.org/issues/16","id":111498225,"number":16,"title":"Project: Document All Modules","user":{"login":"zoffixznet","id":5747918,"avatar_url":"https://avatars.githubusercontent.com/u/5747918?v=3","gravatar_id":"","url":"https://api.github.com/users/zoffixznet","html_url":"https://github.com/zoffixznet","followers_url":"https://api.github.com/users/zoffixznet/followers","following_url":"https://api.github.com/users/zoffixznet/following{/other_user}","gists_url":"https://api.github.com/users/zoffixznet/gists{/gist_id}","starred_url":"https://api.github.com/users/zoffixznet/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/zoffixznet/subscriptions","organizations_url":"https://api.github.com/users/zoffixznet/orgs","repos_url":"https://api.github.com/users/zoffixznet/repos","events_url":"https://api.github.com/users/zoffixznet/events{/privacy}","received_events_url":"https://api.github.com/users/zoffixznet/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/perl6/modules.perl6.org/labels/wishlist","name":"wishlist","color":"0052cc"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":11,"created_at":"2015-10-14T21:33:40Z","updated_at":"2015-11-14T21:28:09Z","closed_at":null,"body":"### The Problem\r\n\r\nThere are many modules in the ecosystem that lack any useful documentation. I've actually heard someone refer to this as \"Perl 6's culture of no documentation.\"\r\n\r\n### The Solution\r\n\r\nWe're about to have many new comers and having a simple way to contribute would be [good for the growth of the community](http://sarah.thesharps.us/2015/10/06/what-makes-a-good-community/).\r\n\r\n1) Same as with the [Most Wanted Modules Wiki](https://github.com/perl6/perl6-most-wanted/blob/master/most-wanted/modules.md), we should have one for *Documentation Wanted*. \r\n2) Those who are new to the language could study those modules, figure out how they work, document the behaviour, and submit a doc PR.\r\n\r\nIn summation, I think this can be a great entry-level task for new comers to contribute to, while at the same time eradicating the \"no documentation culture\".\r\n\r\n"},"comment":{"url":"https://api.github.com/repos/perl6/modules.perl6.org/issues/comments/156747156","html_url":"https://github.com/perl6/modules.perl6.org/issues/16#issuecomment-156747156","issue_url":"https://api.github.com/repos/perl6/modules.perl6.org/issues/16","id":156747156,"user":{"login":"teodozjan","id":3833045,"avatar_url":"https://avatars.githubusercontent.com/u/3833045?v=3","gravatar_id":"","url":"https://api.github.com/users/teodozjan","html_url":"https://github.com/teodozjan","followers_url":"https://api.github.com/users/teodozjan/followers","following_url":"https://api.github.com/users/teodozjan/following{/other_user}","gists_url":"https://api.github.com/users/teodozjan/gists{/gist_id}","starred_url":"https://api.github.com/users/teodozjan/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/teodozjan/subscriptions","organizations_url":"https://api.github.com/users/teodozjan/orgs","repos_url":"https://api.github.com/users/teodozjan/repos","events_url":"https://api.github.com/users/teodozjan/events{/privacy}","received_events_url":"https://api.github.com/users/teodozjan/received_events","type":"User","site_admin":false},"created_at":"2015-11-14T21:28:08Z","updated_at":"2015-11-14T21:28:08Z","body":"Hi, I've tried my best to provide coverage but I see little issue about noninline documentation.\r\n\r\nThere several ways people do their documentation.\r\n\r\nJSON::RPC is documented inside README\r\nDBIsh uses EOF pod for major classes\r\nFile::Find uses EOF pod mentioning method as C<>\r\nalso someone used headers to document subs/methods \r\n\r\nAre we going to support anything? Or just cover some standard?"}}