{"action":"created","issue":{"url":"https://api.github.com/repos/RIOT-OS/RIOT/issues/4072","labels_url":"https://api.github.com/repos/RIOT-OS/RIOT/issues/4072/labels{/name}","comments_url":"https://api.github.com/repos/RIOT-OS/RIOT/issues/4072/comments","events_url":"https://api.github.com/repos/RIOT-OS/RIOT/issues/4072/events","html_url":"https://github.com/RIOT-OS/RIOT/issues/4072","id":110643408,"number":4072,"title":"doc: Update and provide high-level doc for all the important modules","user":{"login":"authmillenon","id":675644,"avatar_url":"https://avatars.githubusercontent.com/u/675644?v=3","gravatar_id":"","url":"https://api.github.com/users/authmillenon","html_url":"https://github.com/authmillenon","followers_url":"https://api.github.com/users/authmillenon/followers","following_url":"https://api.github.com/users/authmillenon/following{/other_user}","gists_url":"https://api.github.com/users/authmillenon/gists{/gist_id}","starred_url":"https://api.github.com/users/authmillenon/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/authmillenon/subscriptions","organizations_url":"https://api.github.com/users/authmillenon/orgs","repos_url":"https://api.github.com/users/authmillenon/repos","events_url":"https://api.github.com/users/authmillenon/events{/privacy}","received_events_url":"https://api.github.com/users/authmillenon/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/RIOT-OS/RIOT/labels/documentation","name":"documentation","color":"f7c6c7"}],"state":"open","locked":false,"assignee":{"login":"emmanuelsearch","id":3717254,"avatar_url":"https://avatars.githubusercontent.com/u/3717254?v=3","gravatar_id":"","url":"https://api.github.com/users/emmanuelsearch","html_url":"https://github.com/emmanuelsearch","followers_url":"https://api.github.com/users/emmanuelsearch/followers","following_url":"https://api.github.com/users/emmanuelsearch/following{/other_user}","gists_url":"https://api.github.com/users/emmanuelsearch/gists{/gist_id}","starred_url":"https://api.github.com/users/emmanuelsearch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/emmanuelsearch/subscriptions","organizations_url":"https://api.github.com/users/emmanuelsearch/orgs","repos_url":"https://api.github.com/users/emmanuelsearch/repos","events_url":"https://api.github.com/users/emmanuelsearch/events{/privacy}","received_events_url":"https://api.github.com/users/emmanuelsearch/received_events","type":"User","site_admin":false},"milestone":{"url":"https://api.github.com/repos/RIOT-OS/RIOT/milestones/12","html_url":"https://github.com/RIOT-OS/RIOT/milestones/Release%202015.09","labels_url":"https://api.github.com/repos/RIOT-OS/RIOT/milestones/12/labels","id":1088995,"number":12,"title":"Release 2015.09","description":"This release aims mainly to include the gnrc network stack as the new default IPv6/6LoWPAN stack.","creator":{"login":"OlegHahm","id":1590423,"avatar_url":"https://avatars.githubusercontent.com/u/1590423?v=3","gravatar_id":"","url":"https://api.github.com/users/OlegHahm","html_url":"https://github.com/OlegHahm","followers_url":"https://api.github.com/users/OlegHahm/followers","following_url":"https://api.github.com/users/OlegHahm/following{/other_user}","gists_url":"https://api.github.com/users/OlegHahm/gists{/gist_id}","starred_url":"https://api.github.com/users/OlegHahm/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/OlegHahm/subscriptions","organizations_url":"https://api.github.com/users/OlegHahm/orgs","repos_url":"https://api.github.com/users/OlegHahm/repos","events_url":"https://api.github.com/users/OlegHahm/events{/privacy}","received_events_url":"https://api.github.com/users/OlegHahm/received_events","type":"User","site_admin":false},"open_issues":16,"closed_issues":611,"state":"open","created_at":"2015-04-29T10:11:27Z","updated_at":"2015-10-09T11:58:55Z","due_on":"2015-09-17T22:00:00Z","closed_at":null},"comments":24,"created_at":"2015-10-09T11:58:55Z","updated_at":"2015-10-13T21:42:29Z","closed_at":null,"body":"As discussed in the [meeting from 2015-10-07](http://riot.pad.spline.de/21), we want to update and enhance the current state of the documentation for several of our most important modules. This encompasses high-level documentation of their internals and How-Tos for their internals (as a well documented example). The modules in questions are:\r\n\r\n* low-level device drivers (`periph`) => @thomaseichinger \r\n - `periph/doc.txt` (general documentation)\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `periph/adc.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `periph/cpuid.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `periph/dac.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `periph/gpio.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `periph/i2c.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `periph/pwm.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `periph/random.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `periph/rtc.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `periph/rtt.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `periph/spi.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `periph/timer.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `periph/uart.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n* network device API (`netdev2`) => @kaspar030\r\n - [ ] high-level doc\r\n - [ ] How-To\r\n* generic network stack (`gnrc`) => @cgundogan\r\n - `net/gnrc.h` (general documentation)\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `net/gnrc/ipv6.h` etc.\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `net/gnrc/netapi.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `net/gnrc/netdev.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `net/gnrc/netif.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `net/gnrc/netreg.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `net/gnrc/nettype.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `net/gnrc/pktbuf.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `net/gnrc/pkt.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `net/gnrc/sixlowpan.h` etc.\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `net/gnrc/udp.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n* connection API (`conn`) => @authmillenon\r\n - `net/conn.h` (general documentation)\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `net/conn/ip.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `net/conn/tcp.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - `net/conn/udp.h`\r\n    + [ ] high-level doc\r\n    + [ ] How-To\r\n - ... things to come\r\n* RIOT's module system => @OlegHahm\r\n - [ ] high-level doc\r\n - [ ] How-To\r\n* RIOT's package system => @Kijewski or @LudwigOrtmann \r\n - [ ] high-level doc\r\n - [ ] How-To\r\n* RIOT's auto-initialization => @OlegHahm \r\n - [ ] high-level doc\r\n - [ ] How-To\r\n* `xtimer` => @kaspar030 \r\n - [ ] high-level doc\r\n - [ ] How-To\r\n* generic sensor interface `saul` => @haukepetersen\r\n - [ ] high-level doc\r\n - [ ] How-To\r\n\r\nThe assignments to the modules are people that to my opinion would be best suited to write the documentation. If you don't agree, either change it or let's discuss it. An assignment could also be interpreted that you can sub-delegate the tasks to other people."},"comment":{"url":"https://api.github.com/repos/RIOT-OS/RIOT/issues/comments/147862470","html_url":"https://github.com/RIOT-OS/RIOT/issues/4072#issuecomment-147862470","issue_url":"https://api.github.com/repos/RIOT-OS/RIOT/issues/4072","id":147862470,"user":{"login":"authmillenon","id":675644,"avatar_url":"https://avatars.githubusercontent.com/u/675644?v=3","gravatar_id":"","url":"https://api.github.com/users/authmillenon","html_url":"https://github.com/authmillenon","followers_url":"https://api.github.com/users/authmillenon/followers","following_url":"https://api.github.com/users/authmillenon/following{/other_user}","gists_url":"https://api.github.com/users/authmillenon/gists{/gist_id}","starred_url":"https://api.github.com/users/authmillenon/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/authmillenon/subscriptions","organizations_url":"https://api.github.com/users/authmillenon/orgs","repos_url":"https://api.github.com/users/authmillenon/repos","events_url":"https://api.github.com/users/authmillenon/events{/privacy}","received_events_url":"https://api.github.com/users/authmillenon/received_events","type":"User","site_admin":false},"created_at":"2015-10-13T21:42:29Z","updated_at":"2015-10-13T21:42:29Z","body":"See #4090 for the addition to `doc/`"}}