Open savetheclocktower opened 1 month ago
@savetheclocktower This is a great feature request. Totally agree that this is a great start on including more information.
There's honestly more information I want included on this page, but being honest I do worry about how much time it'd take me to figure out the CSS side, when I'm hoping to get my CSS changes merged on the docs repo, since then I'd rather get these sites using the same styles,
But this is especially a great start
@savetheclocktower This is a great feature request. Totally agree that this is a great start on including more information.
There's honestly more information I want included on this page, but being honest I do worry about how much time it'd take me to figure out the CSS side, when I'm hoping to get my CSS changes merged on the docs repo, since then I'd rather get these sites using the same styles,
But this is especially a great start
Start from the backend: make whatever changes you'd want to make in order to support the display of extra explanatory badge-related text on a package's details page. I'll handle the CSS. We don't have to ship something perfect to start.
I appreciate that, I'll start looking at what we could do to get badges improved
Have you checked for existing feature requests?
Summary
Some packages are outdated or broken or archived and are indicated as such in the package “card” partial that is shown in package lists and on the package details page. But they're arguably a bit too subtle on the latter page.
For instance: suppose I visit the page for
busy-signal
. I may or may not notice the red pill-shaped “outdated” badge near the package's name, but it's less likely I'll realize that the badge itself links to a page that gives more information.Ideally, that information would be shown in an info box near the top of the package README:
If this weren't possible, we could at least include as much information as is contained in the badge:
What benefits does this feature provide?
Sometimes badges carry important caveats (this package is outdated or broken) and sometimes they're almost ornamental (this package is made for Pulsar, so you should feel better about installing it!).
I recently mentioned to a user in passing that they should install
linter-eslint-node
if they want ESLint integration — forgetting that the last Atom version had some bugs and that the package's registry page doesn't make it obvious that you shouldn't click on the Install button on the page and should instead install by running a command in your terminal.Any alternatives?
It's possible that we should also flesh out the metadata that's available from the API so that we can deliver explanatory text straight to the package's detail page instead of merely linking to it on GitHub.
Other examples:
No response