{"action":"created","issue":{"url":"https://api.github.com/repos/nteract/nteract/issues/3553","repository_url":"https://api.github.com/repos/nteract/nteract","labels_url":"https://api.github.com/repos/nteract/nteract/issues/3553/labels{/name}","comments_url":"https://api.github.com/repos/nteract/nteract/issues/3553/comments","events_url":"https://api.github.com/repos/nteract/nteract/issues/3553/events","html_url":"https://github.com/nteract/nteract/issues/3553","id":375159031,"node_id":"MDU6SXNzdWUzNzUxNTkwMzE=","number":3553,"title":"Investigate tools for TypeScript documentation of source files","user":{"login":"willingc","id":2680980,"node_id":"MDQ6VXNlcjI2ODA5ODA=","avatar_url":"https://avatars3.githubusercontent.com/u/2680980?v=4","gravatar_id":"","url":"https://api.github.com/users/willingc","html_url":"https://github.com/willingc","followers_url":"https://api.github.com/users/willingc/followers","following_url":"https://api.github.com/users/willingc/following{/other_user}","gists_url":"https://api.github.com/users/willingc/gists{/gist_id}","starred_url":"https://api.github.com/users/willingc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/willingc/subscriptions","organizations_url":"https://api.github.com/users/willingc/orgs","repos_url":"https://api.github.com/users/willingc/repos","events_url":"https://api.github.com/users/willingc/events{/privacy}","received_events_url":"https://api.github.com/users/willingc/received_events","type":"User","site_admin":false},"labels":[{"id":451663695,"node_id":"MDU6TGFiZWw0NTE2NjM2OTU=","url":"https://api.github.com/repos/nteract/nteract/labels/docs","name":"docs","color":"e99695","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2018-10-29T18:34:51Z","updated_at":"2018-10-30T13:42:34Z","closed_at":null,"author_association":"MEMBER","body":"@captainsafia and I had a conversation yesterday where we discussed possible approaches to creating documentation for source files after the TypeScript migration. Opening this issue to capture ideas.\r\n\r\nSeveral tools have emerged along with writing a custom tool or bridge. Some of the available tools:\r\n\r\n- TypeDoc http://typedoc.org/\r\n-  TSDoc https://github.com/Microsoft/tsdoc a doc comment standard\r\n- Styleguidist with TS or JSON\r\n\r\nArticles of interest\r\n- https://blog.cloudflare.com/generating-documentation-for-typescript-projects/\r\n\r\nOne of the goals is to deliver visually appealing docs similar to the current components.nteract.io docs"},"comment":{"url":"https://api.github.com/repos/nteract/nteract/issues/comments/434305477","html_url":"https://github.com/nteract/nteract/issues/3553#issuecomment-434305477","issue_url":"https://api.github.com/repos/nteract/nteract/issues/3553","id":434305477,"node_id":"MDEyOklzc3VlQ29tbWVudDQzNDMwNTQ3Nw==","user":{"login":"captainsafia","id":1857993,"node_id":"MDQ6VXNlcjE4NTc5OTM=","avatar_url":"https://avatars2.githubusercontent.com/u/1857993?v=4","gravatar_id":"","url":"https://api.github.com/users/captainsafia","html_url":"https://github.com/captainsafia","followers_url":"https://api.github.com/users/captainsafia/followers","following_url":"https://api.github.com/users/captainsafia/following{/other_user}","gists_url":"https://api.github.com/users/captainsafia/gists{/gist_id}","starred_url":"https://api.github.com/users/captainsafia/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/captainsafia/subscriptions","organizations_url":"https://api.github.com/users/captainsafia/orgs","repos_url":"https://api.github.com/users/captainsafia/repos","events_url":"https://api.github.com/users/captainsafia/events{/privacy}","received_events_url":"https://api.github.com/users/captainsafia/received_events","type":"User","site_admin":false},"created_at":"2018-10-30T13:42:34Z","updated_at":"2018-10-30T13:42:34Z","author_association":"MEMBER","body":"I did some more research and as it turns out, we can get monorepo support for TypeDoc using this plugin (https://github.com/christopherthielen/typedoc-plugin-external-module-name) to dictate each source file as part of a particular module and render them under the same header in the navigation. "}}
{"actor":{"display_login":"captainsafia"}}