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

docs: update README for JSR #4654

Merged
merged 1 commit into from
Apr 29, 2024
Merged

docs: update README for JSR #4654

merged 1 commit into from
Apr 29, 2024

Conversation

iuioiua
Copy link
Collaborator

@iuioiua iuioiua commented Apr 29, 2024

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:

/**
 * This module does this and that.
 *
 * Note: this module is unstable and may change in the future.
 * @module
 */

and

/**
 * This module does this and that.
 *
 * Note: this module is settled and is unlikely to change in the future.
 * @module
 */

Supercedes #4652

@iuioiua iuioiua marked this pull request as ready for review April 29, 2024 06:30
@iuioiua iuioiua requested a review from kt3k as a code owner April 29, 2024 06:30
Copy link

codecov bot commented Apr 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.36%. Comparing base (3155f00) to head (c99c495).

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.
📢 Have feedback on the report? Share it here.

Copy link
Member

@kt3k kt3k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@iuioiua iuioiua merged commit 10b8a70 into main Apr 29, 2024
12 checks passed
@iuioiua iuioiua deleted the update-readme-std branch April 29, 2024 07:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants