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

Feat: when rendering @types docs, combine the @types README with the library's own README #14

Open
cspotcode opened this issue Jul 15, 2021 · 3 comments

Comments

@cspotcode
Copy link
Collaborator

cspotcode commented Jul 15, 2021

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.

@cspotcode
Copy link
Collaborator Author

Hmm, maybe the API won't give us the README. But we can grab it from unpkg.com or npm pack

@keithlayne
Copy link
Collaborator

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.

@cspotcode
Copy link
Collaborator Author

Yeah, I think it's usually copied by hand, written by hand, or copied from elsewhere if the source package doesn't have JSDoc.

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

2 participants