{"action":"created","issue":{"url":"https://api.github.com/repos/amethyst/amethyst/issues/1044","repository_url":"https://api.github.com/repos/amethyst/amethyst","labels_url":"https://api.github.com/repos/amethyst/amethyst/issues/1044/labels{/name}","comments_url":"https://api.github.com/repos/amethyst/amethyst/issues/1044/comments","events_url":"https://api.github.com/repos/amethyst/amethyst/issues/1044/events","html_url":"https://github.com/amethyst/amethyst/issues/1044","id":371235506,"node_id":"MDU6SXNzdWUzNzEyMzU1MDY=","number":1044,"title":"Better reference / architectural overview of Amethyst","user":{"login":"SamuelMoriarty","id":3159552,"node_id":"MDQ6VXNlcjMxNTk1NTI=","avatar_url":"https://avatars0.githubusercontent.com/u/3159552?v=4","gravatar_id":"","url":"https://api.github.com/users/SamuelMoriarty","html_url":"https://github.com/SamuelMoriarty","followers_url":"https://api.github.com/users/SamuelMoriarty/followers","following_url":"https://api.github.com/users/SamuelMoriarty/following{/other_user}","gists_url":"https://api.github.com/users/SamuelMoriarty/gists{/gist_id}","starred_url":"https://api.github.com/users/SamuelMoriarty/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/SamuelMoriarty/subscriptions","organizations_url":"https://api.github.com/users/SamuelMoriarty/orgs","repos_url":"https://api.github.com/users/SamuelMoriarty/repos","events_url":"https://api.github.com/users/SamuelMoriarty/events{/privacy}","received_events_url":"https://api.github.com/users/SamuelMoriarty/received_events","type":"User","site_admin":false},"labels":[{"id":311017745,"node_id":"MDU6TGFiZWwzMTEwMTc3NDU=","url":"https://api.github.com/repos/amethyst/amethyst/labels/pri:%20normal","name":"pri: normal","color":"f7c6c7","default":false},{"id":663029916,"node_id":"MDU6TGFiZWw2NjMwMjk5MTY=","url":"https://api.github.com/repos/amethyst/amethyst/labels/project:%20docs","name":"project: docs","color":"0e8a16","default":false},{"id":311016918,"node_id":"MDU6TGFiZWwzMTEwMTY5MTg=","url":"https://api.github.com/repos/amethyst/amethyst/labels/type:%20task","name":"type: task","color":"84b6eb","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":{"url":"https://api.github.com/repos/amethyst/amethyst/milestones/6","html_url":"https://github.com/amethyst/amethyst/milestone/6","labels_url":"https://api.github.com/repos/amethyst/amethyst/milestones/6/labels","id":3680788,"node_id":"MDk6TWlsZXN0b25lMzY4MDc4OA==","number":6,"title":"0.10","description":"","creator":{"login":"Moxinilian","id":30992420,"node_id":"MDQ6VXNlcjMwOTkyNDIw","avatar_url":"https://avatars0.githubusercontent.com/u/30992420?v=4","gravatar_id":"","url":"https://api.github.com/users/Moxinilian","html_url":"https://github.com/Moxinilian","followers_url":"https://api.github.com/users/Moxinilian/followers","following_url":"https://api.github.com/users/Moxinilian/following{/other_user}","gists_url":"https://api.github.com/users/Moxinilian/gists{/gist_id}","starred_url":"https://api.github.com/users/Moxinilian/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Moxinilian/subscriptions","organizations_url":"https://api.github.com/users/Moxinilian/orgs","repos_url":"https://api.github.com/users/Moxinilian/repos","events_url":"https://api.github.com/users/Moxinilian/events{/privacy}","received_events_url":"https://api.github.com/users/Moxinilian/received_events","type":"User","site_admin":false},"open_issues":16,"closed_issues":3,"state":"open","created_at":"2018-09-23T20:30:00Z","updated_at":"2018-10-17T19:39:27Z","due_on":null,"closed_at":null},"comments":1,"created_at":"2018-10-17T19:36:57Z","updated_at":"2018-10-17T19:47:29Z","closed_at":null,"author_association":"NONE","body":"Created at the suggestion of @Moxinilian \r\n\r\nRight now, there are three ways to dive into Amethys, in order of ascending complexity:\r\n* The Amethyst introduction book\r\n* The Amethyst docs\r\n* The Amethyst source code\r\n\r\nThe book is a nice resource to get your feet wet with Amethyst and get a general idea of what's going on - however, it doesn't go in-depth on the inner working of Amethyst itself.\r\n\r\nDocs are the next step, however, they generally do not include implementation detail and are not very well suited for understanding what's going on *inside* the engine, just what you can do with it.\r\n\r\nGame development isn't easy, and sometimes you just want/need to dive into the guts of whatever you're working with, to provide an integration, to extend the engine, or just to learn how it all fits together under the hood.\r\n\r\nFor this purpose, some kind of architectural overview or a reference would go a long way, especially around the time when the engine is becoming more or less stabilized. In particular:\r\n* An overview of all the systems in amethyst and their respective crates and how they all interact.\r\n* An overview of each system's implementation and structure. This doesn't have to be super-detailed, but it should provide a general idea of where to look for things you are interested in, and mention important details that users who are interested in studying the code would find helpful.\r\n* Reasoning behind how/why certain decisions in the engine came to be, what are the advantages and the drawbacks of the chosen approach, and if there are any plans for further improvement down the road.\r\n* Give a rough idea of how complete each component is, so people looking to contribute have an easier time finding tasks for themselves, or maybe can even come up with their own (unlogged) improvements.\r\n\r\nThese are just my personal thoughts on what would make a great reference document, something that I personally would appreciate a lot, being a newcomer to the engine."},"comment":{"url":"https://api.github.com/repos/amethyst/amethyst/issues/comments/430763586","html_url":"https://github.com/amethyst/amethyst/issues/1044#issuecomment-430763586","issue_url":"https://api.github.com/repos/amethyst/amethyst/issues/1044","id":430763586,"node_id":"MDEyOklzc3VlQ29tbWVudDQzMDc2MzU4Ng==","user":{"login":"Moxinilian","id":30992420,"node_id":"MDQ6VXNlcjMwOTkyNDIw","avatar_url":"https://avatars0.githubusercontent.com/u/30992420?v=4","gravatar_id":"","url":"https://api.github.com/users/Moxinilian","html_url":"https://github.com/Moxinilian","followers_url":"https://api.github.com/users/Moxinilian/followers","following_url":"https://api.github.com/users/Moxinilian/following{/other_user}","gists_url":"https://api.github.com/users/Moxinilian/gists{/gist_id}","starred_url":"https://api.github.com/users/Moxinilian/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Moxinilian/subscriptions","organizations_url":"https://api.github.com/users/Moxinilian/orgs","repos_url":"https://api.github.com/users/Moxinilian/repos","events_url":"https://api.github.com/users/Moxinilian/events{/privacy}","received_events_url":"https://api.github.com/users/Moxinilian/received_events","type":"User","site_admin":false},"created_at":"2018-10-17T19:47:29Z","updated_at":"2018-10-17T19:47:29Z","author_association":"MEMBER","body":"I think the point was that a \"good first issue\" is pointless if the thing is not very clear to newcomers.\r\nI've seen \"good first issues\" that even myself wasn't exactly sure what needed to be done and how to tackle it."}}
{"actor":{"display_login":"Moxinilian"}}