{"action":"opened","issue":{"url":"https://api.github.com/repos/mikedane/cryptobear/issues/4","repository_url":"https://api.github.com/repos/mikedane/cryptobear","labels_url":"https://api.github.com/repos/mikedane/cryptobear/issues/4/labels{/name}","comments_url":"https://api.github.com/repos/mikedane/cryptobear/issues/4/comments","events_url":"https://api.github.com/repos/mikedane/cryptobear/issues/4/events","html_url":"https://github.com/mikedane/cryptobear/issues/4","id":343429037,"node_id":"MDU6SXNzdWUzNDM0MjkwMzc=","number":4,"title":"Service Layer","user":{"login":"mikedane","id":13106307,"node_id":"MDQ6VXNlcjEzMTA2MzA3","avatar_url":"https://avatars2.githubusercontent.com/u/13106307?v=4","gravatar_id":"","url":"https://api.github.com/users/mikedane","html_url":"https://github.com/mikedane","followers_url":"https://api.github.com/users/mikedane/followers","following_url":"https://api.github.com/users/mikedane/following{/other_user}","gists_url":"https://api.github.com/users/mikedane/gists{/gist_id}","starred_url":"https://api.github.com/users/mikedane/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mikedane/subscriptions","organizations_url":"https://api.github.com/users/mikedane/orgs","repos_url":"https://api.github.com/users/mikedane/repos","events_url":"https://api.github.com/users/mikedane/events{/privacy}","received_events_url":"https://api.github.com/users/mikedane/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2018-07-22T18:46:38Z","updated_at":"2018-07-22T18:46:38Z","closed_at":null,"author_association":"OWNER","body":"Below is a list of suggested changes/improvements that can be made to the existing documentation on the X page in response to #4116\r\n\r\nSince this documentation is split up into multiple sections, paragraphs and code examples I've used the following notation to make it easy to locate (and fix) the specified issues within the documentation. \r\n\r\nIssues will first be identified by the high level section of the documentation they are in (ex. Overview, Key-Value Observables, etc), then by either the paragraph number or code example number. A paragraph here is defined as any block of text which is separated from surrounding text/code examples by a blank new line, and a code example is any section of the docs that contains code and is again separated from other text/code examples by a blank new line. I also may refer to images in the same manner. \r\n\r\n## General Notes\r\nThese are general things that need to be fixed throughout the entire page:\r\n\r\n## Overview\r\n- [ ] p1, 1st sentence - _Most applications need to request data from ~the~ a server_.\r\n\r\n## Creating a model\r\n- [ ] p1, 1st sentence - _CanJS's pattern is **such** that you define application logic..._\r\n- [ ] code block 1 - This code block is fairly straightforward, but when creating the `Todo` observable the object fields `dueDate`, `name`, and `complete` are not explained. I don't think it's necessarily reasonable to assume that the user is going to understand what those fields mean, we should put a comment there to explain. \r\n\r\n## Retrieving a list of records\r\n- [ ] code block 1 - This code block doesn't resize with the page and its not responsive. When viewed on a small screen size this could be an issue. Maybe instead of stacking these horizontally we could stack them vertically?\r\n- [ ] code block 3 - There are several code blocks which have these separators\r\n    ![screen shot 2018-07-22 at 2 37 58 pm](https://user-images.githubusercontent.com/13106307/43048913-89e754d2-8dbd-11e8-8af8-663f8c32dadc.png)\r\n    I'm not entirely sure what purpose they serve and they only seem to be used in this section of the docs. We might want to consider removing them so that users don't get confused. \r\n- [ ] code block 4 (the todo list demo) - The code here uses the outdated `var` keyword, it should be using the new `let` and `const` keywords instead. Also we might want to make a note that the checkboxes are intentionally disabled, or users might think something is not working. \r\n- [ ] \r\n\r\n"}}
{"actor":{"display_login":"mikedane"}}