cloudflare / node-cloudflare

Node.js API for Client API

Home Page:https://cloudflare.github.io/node-cloudflare/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

documentation site should be generated from types

terinjokes opened this issue · comments

Right now the documentation site is generated from JSDoc comments often detached from the implementation, typos and easily result in incorrect documentation. (see #51)

Due to the API's heavy use of variadic arguments, this often results in incomplete definitions of parameters. (see #56, #28)

The documentation generation should be replaced with something that can do the same job but deriving more information from the types.