Skip to content

Commit

Permalink
chore: add new FAQ about yarn version (#6796)
Browse files Browse the repository at this point in the history
* chore: add new FAQ about yarn version

* chore address comments

* chore: address comments

* Update CONTRIBUTING.md

Co-authored-by: Nico Flaig <nflaig@protonmail.com>

* chore: address comments

* chore: address comments

* Update docs/pages/faqs.md

Co-authored-by: Nico Flaig <nflaig@protonmail.com>

* Update docs/pages/faqs.md

Co-authored-by: Nico Flaig <nflaig@protonmail.com>

* chore: address comments

* chore: address comments

* fix: typo

---------

Co-authored-by: Nico Flaig <nflaig@protonmail.com>
  • Loading branch information
jeluard and nflaig authored Jun 5, 2024
1 parent def34eb commit 49c1689
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 0 deletions.
1 change: 1 addition & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Casper
Chai
ChainSafe
Codespaces
Corepack
Customizations
DPoS
DVs
Expand Down
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ When using MacOS, there are a couple of extra prerequisites that are required.

## Getting Started

- :gear: Run `corepack enable` to enable [Corepack](https://nodejs.org/api/corepack.html).
- :gear: Run `yarn` to install dependencies.
- :gear: Run `yarn build` to build lib from source.
- :package: A `lodestar` binary will be bundled in `./packages/cli/bin`.
Expand Down
14 changes: 14 additions & 0 deletions docs/pages/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

This section of the documentation will cover common questions and encounters often asked by users and developers.

## Tooling

:::note "Package manager issues"

Lodestar relies on [Corepack](https://nodejs.org/api/corepack.html) and associated `packageManager` value to manage its package manager version.

Make sure `corepack` is correctly enabled if you encounter some package manager related issues:

```bash
corepack enable
```

:::

## Troubleshooting Lodestar

### Running a beacon node
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"engines": {
"node": ">=20.1.0 <21 || >=22 <23"
},
"packageManager": "yarn@1.22.22+sha256.c17d3797fb9a9115bf375e31bfd30058cac6bc9c3b8807a3d8cb2094794b51ca",
"workspaces": [
"packages/*"
],
Expand Down

0 comments on commit 49c1689

Please sign in to comment.