Skip to content

Commit

Permalink
docs: add documentation contribution instructions (#6294)
Browse files Browse the repository at this point in the history
* add documentation contribution instructions

* docs contribution to include cmd and wordlist

* spell check documentation

* add wordlist check script

* word list correction

* incorporate feedback
  • Loading branch information
philknows authored Jan 18, 2024
1 parent f3eb48a commit 551fd8e
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,20 @@ Run script to download dashboards to `./dashboards` folder
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`

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
```

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.

## Label Guide

Issues and pull requests are subject to the following labeling guidelines.
Expand Down

0 comments on commit 551fd8e

Please sign in to comment.