napi-rs / napi-rs/website

Feedback for “Prepublish”

Open
#47 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
25
Forks
48
Avg merge
3d 22h
Merged PRs (30d)
7

Description

The description in the docs about prepublish is: Running some preparation for publishing NAPI-RS packages. is not helpful. At least there should be a warning that running prepublish command will publish all the platform packages to the NPM repository. I think you should more explicitly describe how the command works, similar to the artifacts page (some preparation doesn't explain much).

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start with the documentation page containing the prepublish description and compare its explanation with the linked artifacts page. Clarify what the command does, explicitly warn that it publishes all platform packages to the NPM repository, and confirm the updated text explains the workflow more fully than “some preparation.”

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.