{"action":"closed","issue":{"url":"https://api.github.com/repos/cfpb/capital-framework/issues/214","repository_url":"https://api.github.com/repos/cfpb/capital-framework","labels_url":"https://api.github.com/repos/cfpb/capital-framework/issues/214/labels{/name}","comments_url":"https://api.github.com/repos/cfpb/capital-framework/issues/214/comments","events_url":"https://api.github.com/repos/cfpb/capital-framework/issues/214/events","html_url":"https://github.com/cfpb/capital-framework/issues/214","id":115146338,"number":214,"title":"Align CF Readmes with OS project template","user":{"login":"KimberlyMunoz","id":1860176,"avatar_url":"https://avatars.githubusercontent.com/u/1860176?v=3","gravatar_id":"","url":"https://api.github.com/users/KimberlyMunoz","html_url":"https://github.com/KimberlyMunoz","followers_url":"https://api.github.com/users/KimberlyMunoz/followers","following_url":"https://api.github.com/users/KimberlyMunoz/following{/other_user}","gists_url":"https://api.github.com/users/KimberlyMunoz/gists{/gist_id}","starred_url":"https://api.github.com/users/KimberlyMunoz/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/KimberlyMunoz/subscriptions","organizations_url":"https://api.github.com/users/KimberlyMunoz/orgs","repos_url":"https://api.github.com/users/KimberlyMunoz/repos","events_url":"https://api.github.com/users/KimberlyMunoz/events{/privacy}","received_events_url":"https://api.github.com/users/KimberlyMunoz/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/cfpb/capital-framework/labels/documentation","name":"documentation","color":"006b75"}],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":{"url":"https://api.github.com/repos/cfpb/capital-framework/milestones/4","html_url":"https://github.com/cfpb/capital-framework/milestones/Backlog","labels_url":"https://api.github.com/repos/cfpb/capital-framework/milestones/4/labels","id":1393977,"number":4,"title":"Backlog","description":"All backlogged items in Capital Framework.","creator":{"login":"KimberlyMunoz","id":1860176,"avatar_url":"https://avatars.githubusercontent.com/u/1860176?v=3","gravatar_id":"","url":"https://api.github.com/users/KimberlyMunoz","html_url":"https://github.com/KimberlyMunoz","followers_url":"https://api.github.com/users/KimberlyMunoz/followers","following_url":"https://api.github.com/users/KimberlyMunoz/following{/other_user}","gists_url":"https://api.github.com/users/KimberlyMunoz/gists{/gist_id}","starred_url":"https://api.github.com/users/KimberlyMunoz/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/KimberlyMunoz/subscriptions","organizations_url":"https://api.github.com/users/KimberlyMunoz/orgs","repos_url":"https://api.github.com/users/KimberlyMunoz/repos","events_url":"https://api.github.com/users/KimberlyMunoz/events{/privacy}","received_events_url":"https://api.github.com/users/KimberlyMunoz/received_events","type":"User","site_admin":false},"open_issues":55,"closed_issues":23,"state":"open","created_at":"2015-11-04T16:47:59Z","updated_at":"2016-08-02T15:20:23Z","due_on":null,"closed_at":null},"comments":3,"created_at":"2015-11-04T20:58:22Z","updated_at":"2016-08-02T15:20:23Z","closed_at":"2016-08-02T15:20:23Z","body":"Original issue: https://github.com/cfpb/cf-core/issues/32\r\n\r\nMove CF projects toward using a Readme more in-line with https://github.com/cfpb/open-source-project-template. Of particular note:\r\n- Include the `LICENSE` (or exclude the link from the Readme). See https://github.com/cfpb/cf-typography/issues/31.\r\n- Include installation instructions for generating the docs. E.g. Run `npm install`, `grunt vendor`, and `grunt` and open the HTML page in `/docs/` in a web browser (also may be worth noting a server doesn't need to be running). \r\n- Consider captioning the screenshot. The screenshot may be self-explanatory in some cases, but other times it may not be clear what's shown. For example, the cf-typography repo has a paragraph of text that turns into an image of lorem ipsum without any explanation of what the reader is looking at:\r\n\r\n----------------------------\r\n![screen shot 2015-03-19 at 2 41 10 pm](https://cloud.githubusercontent.com/assets/704760/6738099/25e71416-ce46-11e4-9c53-2292d148a434.png)\r\n----------------------------\r\n\r\nWithout prior familiarity with the output of the project docs, it's not clear what this image is showing.\r\n\r\n- [ ] cf-core\r\n- [ ] cf-grid\r\n- [ ] cf-icons\r\n- [ ] cf-buttons\r\n- [ ] cf-forms\r\n- [ ] cf-pagination\r\n- [ ] cf-expandables\r\n- [ ] cf-layout\r\n- [ ] cf-typography\r\n- [ ] capital-framework\r\n- [ ] cf-grunt-config\r\n- [ ] cf-component-demo\r\n- [ ] generator-cf"}}
{"actor":{"display_login":"KimberlyMunoz"}}