Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v3 docs #168

Open
ethanresnick opened this issue May 3, 2018 · 0 comments
Open

v3 docs #168

ethanresnick opened this issue May 3, 2018 · 0 comments

Comments

@ethanresnick
Copy link
Owner

ethanresnick commented May 3, 2018

Among other things, Document Adapter contract, including that Adapter.find must remove duplicate resources.

Ideally, I'd like to have: 1) a website with manually written docs that are much more thorough; and/or 2) some auto-generated docs based on my type signatures + jsdoc comments, which could provide the basis for a docs site.

The trick around auto-generated API docs is that there doesn't seem to be a perfect tool for it yet:

  • API Extractor mixed with API Documenter seems like it could be perfect, but API Extractor still uses an old version of TS, which doesn't support some of the TS features we're using. See [api-extractor] Update Typescript dependency? microsoft/rushstack#689 Also, the errors API Extractor gives are quite cryptic. That said, it's very robust in making sure I've clarified what's intended to be public and what's private, and exported all the public types.

  • Type Doc is also on an old version of Typescript, but seems like updates there have been blocked even longer, and its API auditing is far less thorough/useful.

  • Finally, there's Tygen, which is nice in that it does support newer Typescript versions, but seems pretty immature/beta. It threw an error when trying to run it over json-api.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant