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

documentation page for a package should list the entrypoints in a better way #606

Open
skybrian opened this issue Jun 13, 2024 · 3 comments
Assignees
Labels
docs gen Related to the documentation generation upstream Issue is in upstream project

Comments

@skybrian
Copy link

skybrian commented Jun 13, 2024

I'm looking at:

https://jsr.io/@std/testing/doc

And comparing to the deno.land page:

https://deno.land/[email protected]/testing

The deno.land page indicates modules much more clearly, with modules listed on the left and their contents on the right. Could the JSR documentation look like that, or be improved somehow?

Here's another example that I was originally confused by.

@github-project-automation github-project-automation bot moved this to Needs Triage in JSR Jun 13, 2024
@skybrian skybrian changed the title documentation page for a package should list the libraries in it frst documentation page for a package should list the modules in a better way Jun 13, 2024
@lucacasonato lucacasonato added the docs gen Related to the documentation generation label Jul 12, 2024
@skybrian skybrian changed the title documentation page for a package should list the modules in a better way documentation page for a package should list the entrypoints in a better way Aug 29, 2024
@skybrian
Copy link
Author

To add some context, these groupings are "entrypoints," which are documented here: https://jsr.io/docs/using-packages#entrypoints

@dgreensp
Copy link

dgreensp commented Nov 28, 2024

Yes, my first experience with JSR was being confused by the fact that the entrypoints of a package don't seem to be listed anywhere, though you can read deno.json in the Files tab. In actuality, they are the section names in the Docs tab—which you can see if you scroll down and down and down, though they don't look like much—but there is no table of contents.

An issue that added to the confusion for me is that the "default" entrypoint does not seem to get a Docs page that lists its symbols. If you click the word "default," for example on https://jsr.io/@std/io/doc, it just takes you to the Overview tab. (It also takes two taps to click "default" on mobile, strangely.) Because it's not clear what "default" refers to, and clicking on it does not take you to a Docs page, and the section names don't look like entrypoints (or anything in particular), coupled with the lack of TOC, the whole thing is disorienting and doesn't make it seem like you are being shown the modules within a package, or even that each module has a page.

Even when you do make it to a module page, it's not reflected in the heading or summary at the top of the page.

On mobile, there is only one easy-to-miss place where the fact that you've navigated appears on the screen. (Even the instructions for importing the module appear to be instructions for importing the package, until you scroll down!)

image

@dgreensp
Copy link

I know this issue might sit for a while, but please consider improving the Docs navigation.

While I didn't consciously know what the problem was initially, the "lack of a sense of place" and lack of navigation on JSR made me not want to use it initially.

Having the docs is one of the selling points of JSR, but the fact that they are not really good docs (compared to other docs site generators, no offense) creates a bit of a dilemma.

@crowlKats crowlKats self-assigned this Jan 16, 2025
@crowlKats crowlKats moved this from Needs Triage to Ready in JSR Jan 16, 2025
@crowlKats crowlKats added the upstream Issue is in upstream project label Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs gen Related to the documentation generation upstream Issue is in upstream project
Projects
Status: Ready
Development

No branches or pull requests

5 participants