Skip to content

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

@cspotcode

Description

@cspotcode

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions