docs: update README for JSR #4654
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4654 +/- ##
=======================================
Coverage 91.36% 91.36%
=======================================
Files 477 477
Lines 37334 37334
Branches 5325 5325
=======================================
Hits 34109 34109
Misses 3164 3164
Partials 61 61 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change trims some of the README, by relying more on JSR's usage instructions built-in to package pages.
My thinking is that JSR already does a fine job at instructing the reader on how to use the package and further usage instructions simply aren't needed elsewhere. This should also act as more of a forcing function to improve our documentation.
I'd like to complete remove the packages table once jsr-io/jsr#421 is merged, so there's no need to maintain such a list. We can instead have a note on each package's module documentation like so:
and
Supercedes #4652