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

Open
#3,597 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
deno, typescript

Research direction

Start with the unchecked items under “JSR Maintainer Actions” and “Documentation efforts”; the completed entries link to issues #3600, #3598, #3603, and #3604 for examples of the work. Review the linked package pages and Fresh entry points for the remaining descriptions, module docs, and public types. Done when the outstanding checklist items are addressed or tracked separately; the issue leaves several choices open and has no recent discussion.

Written by the indexing model from the issue text.

Description

docs feat

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?

Dominant language
TypeScript
Stars
13.8k
Forks
757
Avg merge
3m
Merged PRs (30d)
2

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from freshframework/fresh

All issues in freshframework/fresh

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.