{"action":"opened","issue":{"url":"https://api.github.com/repos/m-labs/artiq/issues/867","repository_url":"https://api.github.com/repos/m-labs/artiq","labels_url":"https://api.github.com/repos/m-labs/artiq/issues/867/labels{/name}","comments_url":"https://api.github.com/repos/m-labs/artiq/issues/867/comments","events_url":"https://api.github.com/repos/m-labs/artiq/issues/867/events","html_url":"https://github.com/m-labs/artiq/issues/867","id":281905657,"number":867,"title":"Developer documentation","user":{"login":"hartytp","id":21218399,"avatar_url":"https://avatars0.githubusercontent.com/u/21218399?v=4","gravatar_id":"","url":"https://api.github.com/users/hartytp","html_url":"https://github.com/hartytp","followers_url":"https://api.github.com/users/hartytp/followers","following_url":"https://api.github.com/users/hartytp/following{/other_user}","gists_url":"https://api.github.com/users/hartytp/gists{/gist_id}","starred_url":"https://api.github.com/users/hartytp/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hartytp/subscriptions","organizations_url":"https://api.github.com/users/hartytp/orgs","repos_url":"https://api.github.com/users/hartytp/repos","events_url":"https://api.github.com/users/hartytp/events{/privacy}","received_events_url":"https://api.github.com/users/hartytp/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2017-12-13T21:38:14Z","updated_at":"2017-12-13T21:38:14Z","closed_at":null,"author_association":"NONE","body":"Are there any plans to improve the coverage of documentation for ARTIQ/misoc/migen?\r\n\r\nThe ARTIQ user-facing documentation is generally pretty good. But, as soon as one wants to look at how things are implemented, the documentation becomes sparse to nonexistent. Currently, understanding how things are implemented in ARTIQ means reading and properly understanding the sources of large chunks of ARTIQ+migen+misoc.  Short (often single-letter) function and variable names also don't help users to get up to speed!\r\n\r\nIt would be great to have both high-level docs explaining how things fit together, as well as brief explanations of how/when to use common components (e.g. misoc.interconect.stream.Endpoint).\r\n\r\n"}}
{"actor":{"display_login":"hartytp"}}