fresh icon indicating copy to clipboard operation
fresh copied to clipboard

JSR: Improve score with improved documentation, examples and package settings

Open csvn opened this issue 2 months ago β€’ 0 comments

Given that Fresh is used by Deno and a very well used and visible package, it would be great if all packages under the @fresh scope on JSR had high scores.

Show current scores πŸ‘‡ Image Image

I've created this issue as an umbrella issue to track various adjustments that should be quick to do to help improve scoring for all packages.

JSR Maintainer Actions

Requires admin/member of @fresh to update.

Has provenance βœ…

Mark deno as compatible runtime

Add description to the package

  • [ ] @fresh/build-id
    • Suggestion: Internal Fresh dependency, do not use directly
  • [ ] @fresh/core
    • Suggestion: Fresh is a small, fast and extensible full stack web framework built on Web Standards. It’s designed for building high-quality, performant, and personalized web applications
    • (Text taken from from README.md)
  • [ ] @fresh/init
    • Suggestion: A CLI tool to bootstrap a new Fresh project
    • (Text taken from from README.md)
  • [ ] @fresh/plugin-tailwind
    • Suggestion: A plugin for Fresh to use Tailwind CSS
  • [ ] @fresh/plugin-tailwind-v3
    • Suggestion: A plugin for Fresh to use Tailwind CSS v3
  • [ ] @fresh/update
    • Suggestion: A CLI tool to help upgrade an existing Fresh project
    • (Text taken from from README.md)

Documentation efforts

No slow types βœ…

Examples in README.md or module doc

Module docs for all entrypoints

Has docs for most symbols

As this task is much larger than the other steps, this is tracked separately.

  • [ ] #3596

Export non-exported public API types

A non-exhaustive list of types that probably should be made public, as they are used in public signatures already.

Types from other dependencies

There are some types in the JSR automated documentation that comes from other packages, e.g. @fresh/plugin-tailwind using a @fresh/core/dev type, or @fresh/core using preact types. What's best practice here? How to make types linked to the correct definition?

csvn avatar Nov 04 '25 11:11 csvn