You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The @types README is informative but not useful if you're trying to actually use the library. The library's own README is what you want, and we can pull it from npm's API.
There's probably more that we need from the actual package (not that I can really think of it right now), but I agree that's the README that we want to use.
On a similar note, what about the actual jsdocs? For DT packages, is the jsdoc from the JS sources typically copied by hand into the DT package, or what?
With both packages on hand, we could conceivably merge info from both to generate docs.
The
@types
README is informative but not useful if you're trying to actually use the library. The library's own README is what you want, and we can pull it from npm's API.As an example, when we render docs from @types/ahoy.js, we should still include the README from ahoy.js
https://www.npmjs.com/package/@types/ahoy.js
https://www.npmjs.com/package/ahoy.js
If we think the @types README is worth including, maybe we should concat the two.
The text was updated successfully, but these errors were encountered: