search

KiaraGrouwstra / typical

playground for type-level primitives in TypeScript
MIT License
173 stars 5 forks source link

jsdoc #11

Closed KiaraGrouwstra closed 6 years ago

KiaraGrouwstra commented 6 years ago

I should add docs for these types. I don't think there's anything specifically to aid documenting types, but since these are arguably type functions, I imagine pretending they are functions may mean jsdoc could suffice here. We'd probably also wanna mark which arguments are union-proof.

KiaraGrouwstra commented 6 years ago

typedoc works!

KiaraGrouwstra commented 6 years ago

Reopening. Docs work offline, and on Github pages it sorta works too, yet when browsing to a module, it 404s. I'll have to figure out why.

KiaraGrouwstra commented 6 years ago

found the issue.