fsprojects / fsprojects/Paket

Getting Started: Improve manual setup instructions

Open
#3,498 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
F#
Stars
2.1k
Forks
528
Avg merge
1d 12m
Merged PRs (30d)
54

Description

Description

Point 5 of the Manual setup instructions does not specify how to invoke paket i.e. .paket/paket.exe init.

Also, this downloads the paket.bootstrapper.exe again, which the user would have renamed as per Point 3. This can be a bit confusing for a new user.

Expected behavior

The instructions should specify how to invoke paket initally (paket init). Also, add another point about deleting the newly downloaded paket.bootstrapper.exe after initial invocation.

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

Open the linked Getting Started page and inspect the Manual setup section, especially points 3 and 5. Update the instructions to show how to invoke paket init and clarify what to do with the newly downloaded paket.bootstrapper.exe; the issue is done when the manual setup sequence is unambiguous for a new user.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.