Relative URLs in README starting with /

[dbushell]

If I have a relative URL starting with a forward slash / in a README for example:

[Documentation](/docs/getting-started.md)

JSR will link to jsr.io and 404, e.g. https://jsr.io/docs/getting-started.md

I would expect this to link back to Github. Both GitHub and NPM allow / linking this way.

If the URL is not prefixed with / e.g. docs/getting-started.md JSR links back to GitHub correctly.

[Muhammad-Owais-Warsi]

Hey @dbushell, can you please provide me with the link of the page, where the issue arises.

[dbushell]

@Muhammad-Owais-Warsi see this package for example — the "MIT License" link at the end is /LICENSE

[lucacasonato]

The bug is somewhere in this function, presumably the early return that checks for leading / is wrong at the top of this file: https://github.com/jsr-io/jsr/blob/main/api/src/docs.rs#L131.

[Muhammad-Owais-Warsi]

s somewhere in this function, presumably the early return that checks for leading / is wrong at the top of this file:

Thanks @dbushell

[Muhammad-Owais-Warsi]

The bug is somewhere in this function, presumably the early return that checks for leading / is wrong at the top of this file: https://github.com/jsr-io/jsr/blob/main/api/src/docs.rs#L131.

Hey @marvinhagemeister , are you talking about this code snippet ?

      if key.strip_prefix('/').unwrap_or(key) == entrypoint {
        entrypoint_url = Some(specifier.clone());
      }
    

[inverted-capital]

If the URL is not prefixed with / e.g. docs/getting-started.md JSR links back to GitHub correctly.

Not if the package was published out of a workspace monorepo, in which case it will link relative to the workspace root and 404 #709

[mattvr]

Shouldn't this ideally link to jsr.io/@namespace/repo/version/file instead of github.com/repo/file? There aren't necessarily GH repos for every package, this could properly pin the version, and it might be a more expected & beneficial behavior for relative links to stay on site.

[dbushell]

Shouldn't this ideally link to jsr.io/@namespace/repo/version/file instead of github.com/repo/file? There aren't necessarily GH repos for every package, this could properly pin the version, and it might be a more expected & beneficial behavior for relative links to stay on site.

If the file exists on JSR I'd be fine with that 👍 it's possible the file isn't in the JSR package.

If not I'd say linking back to the original repo, if there is one, should be the fallback. That way publishing the same README to NPM/JSR is possible without broken links.