janet-lang / janet-lang/pkgs

Any chance we could add descriptions to these packages?

Open
#27 4 comments 4 reactions 0 assignees View on GitHub
Dominant language
Janet
Stars
71
Forks
30
PR merge metrics
No merged PRs in 30d

Description

While The Good Place puns are really entertaining, I can imagine newcomers would have a hard time finding what package they need from this package list. Adding a package description somehow would really aid in the usability and approachability of the ecosystem.

It would likely be a breaking change though, because it would require a change in data structure. One workaround might be to have a separate map, mapping package name to description, but it would be a funny lookup problem "okay, this is sounds like the package I need, now to look at the other map to see the URL." But that could be mitigated by a website similar to npmjs.org (jpm.org, anyone?)

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the package-list data structure and the current package entries. Compare the proposed embedded descriptions with a separate name-to-description map, then define the data shape and user-facing behavior that would make package discovery clearer without an awkward lookup.

Written by the indexing model from the issue text.

Assessment

Domain
developer-experience, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.