{"action":"opened","issue":{"url":"https://api.github.com/repos/namely/styleguide/issues/87","labels_url":"https://api.github.com/repos/namely/styleguide/issues/87/labels{/name}","comments_url":"https://api.github.com/repos/namely/styleguide/issues/87/comments","events_url":"https://api.github.com/repos/namely/styleguide/issues/87/events","html_url":"https://github.com/namely/styleguide/issues/87","id":99247829,"number":87,"title":"Using documentation generators to build styleguide site","user":{"login":"HipsterBrown","id":3051193,"avatar_url":"https://avatars.githubusercontent.com/u/3051193?v=3","gravatar_id":"","url":"https://api.github.com/users/HipsterBrown","html_url":"https://github.com/HipsterBrown","followers_url":"https://api.github.com/users/HipsterBrown/followers","following_url":"https://api.github.com/users/HipsterBrown/following{/other_user}","gists_url":"https://api.github.com/users/HipsterBrown/gists{/gist_id}","starred_url":"https://api.github.com/users/HipsterBrown/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/HipsterBrown/subscriptions","organizations_url":"https://api.github.com/users/HipsterBrown/orgs","repos_url":"https://api.github.com/users/HipsterBrown/repos","events_url":"https://api.github.com/users/HipsterBrown/events{/privacy}","received_events_url":"https://api.github.com/users/HipsterBrown/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/namely/styleguide/labels/question","name":"question","color":"cc317c"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":0,"created_at":"2015-08-05T16:43:00Z","updated_at":"2015-08-05T16:43:00Z","closed_at":null,"body":"The way we currently document our React components and styles is very manual and heavy-handed because it's all embedded in a React app. This makes creating and editing any content more work than should be required, and it will lead into out of date documentation as we move forward. \r\n\r\nFor the React components, we could use [react-docgen](https://github.com/reactjs/react-docgen) to create a JSON file for feeding into a set of templates, like https://github.com/pocotan001/react-styleguide-generator. Using that tool means adding some [comment & coding conventions](https://github.com/reactjs/react-docgen#example) to our components, like not destructuring React methods. \r\n\r\nFor the CSS bundle or SCSS partials, we could generate the same type of JSON file using the [postcss parser](https://github.com/postcss/postcss) and some commenting conventions at the top of each file. \r\n\r\nI wanted to explore this idea before we created too much content. Please comment with any feedback for improving this workflow or if you think it's fine the way it is. "}}