purescript / purescript/pursuit

Document latest version of `psc-publish` in /help/authors

Open
#367 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Haskell
Stars
174
Forks
47
PR merge metrics
No merged PRs in 30d

Description

Gzip the JSON output produced by psc-publish and save it to a file.

But psc-publish yields Missing: --manifest FILE --resolutions FILE and I can't find any documentation what those files are supposed to be

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

Review the /help/authors documentation and the current psc-publish behavior, focusing on the required --manifest FILE and --resolutions FILE arguments. Update the example to describe those files and the latest command usage, including how to gzip and save the JSON output; done means authors can follow the example without encountering the missing-argument error.

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
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.