Skip to content

Overview tab seems to prefer JSDoc over README #1202

@LBBO

Description

@LBBO

I stumbled over this issue when looking into https://github.com/paulmillr/qr. On npm, the package's page just renders the README, which is what I (and presumably also the package's author) expected. On jsr, however, the overview tab is completely useless. It seems to be generated from the JSDoc at the top of the index.ts file.

Personally, I would consider this a bug on JSR's end as I would expect Overview to basically be the readme and only the Docs tab to be generated from JSDoc. I guess jsr could also add a config option to have the README be preferred over JSDoc if keeping this as the default is important to you. I wasn't able to find such an option after some brief searching, so I decided to open an issue here instead of in the QR repo.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Needs Triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions