Skip to content

Commit

Permalink
chore: update the website docs (#6565)
Browse files Browse the repository at this point in the history
  • Loading branch information
jeluard committed Mar 20, 2024
1 parent f9676f1 commit 556e5ec
Showing 1 changed file with 2 additions and 8 deletions.
10 changes: 2 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,15 +250,9 @@ node scripts/download_dashboards.mjs

## Contributing to Documentation

When submitting PRs for documentation updates, build and run the documentation locally to ensure functionality before submission. For first time documentation contributors, install the python dependencies with `yarn docs:install`. Build the documentation locally with `yarn docs:build` and serve with `yarn docs:serve`
When submitting PRs for documentation updates, build and run the documentation locally to ensure functionality before submission. First generate the CLI documentation with `yarn docs:build`. Then in the `docs` folder, build the documentation locally with `yarn install` and serve with `yarn start`.

Your locally served documentation will then be accessible at http://localhost:8000.

If you run into build issues due to circular dependencies, branch switching or other incompatibilities, try cleaning your modules and rebuild your dependencies with:

```sh
yarn clean && yarn clean:nm && yarn && yarn build
```
Your locally served documentation will then be accessible at http://localhost:3000/lodestar/.

We also use a spelling [word list](https://github.com/ChainSafe/lodestar/blob/unstable/.wordlist.txt) as part of our documentation checks. If using unrecognized words or abbreviations, please extend the word list to pass checks. Make sure the list is sorted with `./scripts/wordlist_sort.sh` and checked with `./scripts/wordlist_sort_check.sh` for sorting and duplicates.

Expand Down

0 comments on commit 556e5ec

Please sign in to comment.