{"action":"created","issue":{"url":"https://api.github.com/repos/Bungie-net/api/issues/341","repository_url":"https://api.github.com/repos/Bungie-net/api","labels_url":"https://api.github.com/repos/Bungie-net/api/issues/341/labels{/name}","comments_url":"https://api.github.com/repos/Bungie-net/api/issues/341/comments","events_url":"https://api.github.com/repos/Bungie-net/api/issues/341/events","html_url":"https://github.com/Bungie-net/api/issues/341","id":282152971,"number":341,"title":"More documentation and tutorials, specifically for new users","user":{"login":"vthornheart-bng","id":31020340,"avatar_url":"https://avatars1.githubusercontent.com/u/31020340?v=4","gravatar_id":"","url":"https://api.github.com/users/vthornheart-bng","html_url":"https://github.com/vthornheart-bng","followers_url":"https://api.github.com/users/vthornheart-bng/followers","following_url":"https://api.github.com/users/vthornheart-bng/following{/other_user}","gists_url":"https://api.github.com/users/vthornheart-bng/gists{/gist_id}","starred_url":"https://api.github.com/users/vthornheart-bng/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vthornheart-bng/subscriptions","organizations_url":"https://api.github.com/users/vthornheart-bng/orgs","repos_url":"https://api.github.com/users/vthornheart-bng/repos","events_url":"https://api.github.com/users/vthornheart-bng/events{/privacy}","received_events_url":"https://api.github.com/users/vthornheart-bng/received_events","type":"User","site_admin":false},"labels":[{"id":671956749,"url":"https://api.github.com/repos/Bungie-net/api/labels/enhancement","name":"enhancement","color":"84b6eb","default":true},{"id":696021930,"url":"https://api.github.com/repos/Bungie-net/api/labels/spec","name":"spec","color":"5319e7","default":false}],"state":"open","locked":false,"assignee":{"login":"vthornheart-bng","id":31020340,"avatar_url":"https://avatars1.githubusercontent.com/u/31020340?v=4","gravatar_id":"","url":"https://api.github.com/users/vthornheart-bng","html_url":"https://github.com/vthornheart-bng","followers_url":"https://api.github.com/users/vthornheart-bng/followers","following_url":"https://api.github.com/users/vthornheart-bng/following{/other_user}","gists_url":"https://api.github.com/users/vthornheart-bng/gists{/gist_id}","starred_url":"https://api.github.com/users/vthornheart-bng/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vthornheart-bng/subscriptions","organizations_url":"https://api.github.com/users/vthornheart-bng/orgs","repos_url":"https://api.github.com/users/vthornheart-bng/repos","events_url":"https://api.github.com/users/vthornheart-bng/events{/privacy}","received_events_url":"https://api.github.com/users/vthornheart-bng/received_events","type":"User","site_admin":false},"assignees":[{"login":"vthornheart-bng","id":31020340,"avatar_url":"https://avatars1.githubusercontent.com/u/31020340?v=4","gravatar_id":"","url":"https://api.github.com/users/vthornheart-bng","html_url":"https://github.com/vthornheart-bng","followers_url":"https://api.github.com/users/vthornheart-bng/followers","following_url":"https://api.github.com/users/vthornheart-bng/following{/other_user}","gists_url":"https://api.github.com/users/vthornheart-bng/gists{/gist_id}","starred_url":"https://api.github.com/users/vthornheart-bng/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vthornheart-bng/subscriptions","organizations_url":"https://api.github.com/users/vthornheart-bng/orgs","repos_url":"https://api.github.com/users/vthornheart-bng/repos","events_url":"https://api.github.com/users/vthornheart-bng/events{/privacy}","received_events_url":"https://api.github.com/users/vthornheart-bng/received_events","type":"User","site_admin":false}],"milestone":null,"comments":21,"created_at":"2017-12-14T16:08:51Z","updated_at":"2017-12-28T17:35:43Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"Right now, we have fleshed out some of the \"detail\" documentation better than we did in D1: but we're still missing the core introductory experience for people first learning how to use the API.\r\n\r\nThere's no pointer for \"how you get started\", which I think would at least include:\r\n\r\n- How to initially register your application, get an API key, and set yourself up for OAuth (at least in the latter case, we do have a tutorial we can link to)\r\n- How to find someone's Membership ID for example, and use it to fish out the important \"core\" Destiny information needed to make calls to other parts of the API.  Also the different \"points of entry\" you might use: for instance, some devs might want to start with your Bungie.Net information, while others might just care about your information for a specific Platform.  It's a different experience in those two paths, so it would be good to talk about what you have to do for both of those and why you would start with one over the other.\r\n- What it means for an account to have multiple Membership IDs, and what it means to have membership IDs of multiple types.\r\n- The distinction between and meaning of a Membership ID, Character ID, Item ID, and \"Entity Hashes\".\r\n- The relationship between dynamic data pulled from the API, and static data pulled from the Manifest Databases.\r\n- How to set yourself up to extract the Manifest databases\r\n- How to set yourself up to automatically or periodically check for new Manifest database updates\r\n- Examples for the above in at least one code language, at least just for this \"how to get started\" tutorial if nothing else\r\n\r\nI would also like to follow the suggestion in #303 and provide helper visuals for parts of the API that are confusing:\r\n\r\n- Diagrams for the tutorial information above\r\n- Diagrams or in-game screenshots for concepts in the API that are confusing, particularly places where I attempt to explain it with a wall of text (like Vendors, or the ever-increasingly-complicated Socket/Plug system).\r\n\r\nDoes anyone else have suggestions for places in the API that they wish had more fleshed out documentation?"},"comment":{"url":"https://api.github.com/repos/Bungie-net/api/issues/comments/354325521","html_url":"https://github.com/Bungie-net/api/issues/341#issuecomment-354325521","issue_url":"https://api.github.com/repos/Bungie-net/api/issues/341","id":354325521,"user":{"login":"vthornheart-bng","id":31020340,"avatar_url":"https://avatars1.githubusercontent.com/u/31020340?v=4","gravatar_id":"","url":"https://api.github.com/users/vthornheart-bng","html_url":"https://github.com/vthornheart-bng","followers_url":"https://api.github.com/users/vthornheart-bng/followers","following_url":"https://api.github.com/users/vthornheart-bng/following{/other_user}","gists_url":"https://api.github.com/users/vthornheart-bng/gists{/gist_id}","starred_url":"https://api.github.com/users/vthornheart-bng/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vthornheart-bng/subscriptions","organizations_url":"https://api.github.com/users/vthornheart-bng/orgs","repos_url":"https://api.github.com/users/vthornheart-bng/repos","events_url":"https://api.github.com/users/vthornheart-bng/events{/privacy}","received_events_url":"https://api.github.com/users/vthornheart-bng/received_events","type":"User","site_admin":false},"created_at":"2017-12-28T17:35:43Z","updated_at":"2017-12-28T17:35:43Z","author_association":"CONTRIBUTOR","body":"Awesome, looks great!  Thank you for making those, it is deeply appreciated!"}}
{"actor":{"display_login":"vthornheart-bng"}}