Skip to content

Updating package docs (README.md) without having to publish a new version #1205

@AbdulrhmanGoni

Description

@AbdulrhmanGoni

Currently, whenever I want to update the documentation of my package on JSR, I have to publish a new patch version just to update the README.md file even if there are no code changes.

I believe there are many situations where maintainers want to update the documentation (README.md) of their packages without having to publish a new patch version. for example: when adding some notes about rare edge cases or security concerns, adding some extra usage examples or tips, or when covering some details about a new feature that wasn't included accidentally.

It would be very helpful if there were a way to update the package’s README.md and have those edits reflected on the package page on jsr.io without publishing a new version.

I understand that packages on JSR are immutable for reliability and security, but what if package's README.md were managed separately from the actual package code 🤔, since it doesn’t really affect the code that should be immutable.

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