Skip to content

Commit aa59285

Browse files
authored
Improvements and Fixes in Documentation, Including Corrected Command Usage (#4998)
* Fix typo: change 'periodical' to 'periodic' in progress updates description * Fix wrong command in Usage section * fix typo in Development Environment section * Fix typo: change 'Explictly' to 'Explicitly' * Fix typos in Lighthouse UI and Contributing sections * Fix typo: replace 'confirms' with 'conforms' in Beacon Node API description * fix minor typographical error: change 'advice' to 'advise' in SIGILL warning message * Fix spelling error in Detailed Guide section * Revert "Fix typo: change 'Explictly' to 'Explicitly'" This reverts commit 6b07816. * Revert "fix minor typographical error: change 'advice' to 'advise' in SIGILL warning message" This reverts commit a4904a0. * compiled * Revert "compiled" This reverts commit 425a553. * Revert "Revert "compiled"" This reverts commit b1f871c. * Empty commit to trigger CI.
1 parent 01ec42e commit aa59285

File tree

6 files changed

+8
-8
lines changed

6 files changed

+8
-8
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ as the canonical staking deposit contract address.
4141
The [Lighthouse Book](https://lighthouse-book.sigmaprime.io) contains information for users and
4242
developers.
4343

44-
The Lighthouse team maintains a blog at [lighthouse-blog.sigmaprime.io][blog] which contains periodical
44+
The Lighthouse team maintains a blog at [lighthouse-blog.sigmaprime.io][blog] which contains periodic
4545
progress updates, roadmap insights and interesting findings.
4646

4747
## Branches

account_manager/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,6 @@ Simply run `./account_manager generate` to generate a new random private key,
2929
which will be automatically saved to the correct directory.
3030

3131
If you prefer to use our "deterministic" keys for testing purposes, simply
32-
run `./accounts_manager generate_deterministic -i <index>`, where `index` is
32+
run `./account_manager generate_deterministic -i <index>`, where `index` is
3333
the validator index for the key. This will reliably produce the same key each time
34-
and save it to the directory.
34+
and save it to the directory.

book/src/lighthouse-ui.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Siren is a user interface built for Lighthouse that connects to a Lighthouse Bea
1313
a Lighthouse Validator Client to monitor performance and display key validator
1414
metrics.
1515

16-
The UI is currently in active development. Its resides in the
16+
The UI is currently in active development. It resides in the
1717
[Siren](https://github.com/sigp/siren) repository.
1818

1919
## Topics
@@ -30,5 +30,5 @@ information:
3030

3131
## Contributing
3232

33-
If you find and issue or bug or would otherwise like to help out with the
33+
If you find an issue or bug or would otherwise like to help out with the
3434
development of the Siren project, please submit issues and PRs to the [Siren](https://github.com/sigp/siren) repository.

book/src/setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The additional requirements for developers are:
1616
some dependencies. See [`Installation Guide`](./installation.md) for more info.
1717
- [`java 17 runtime`](https://openjdk.java.net/projects/jdk/). 17 is the minimum,
1818
used by web3signer_tests.
19-
- [`libpq-dev`](https://www.postgresql.org/docs/devel/libpq.html). Also know as
19+
- [`libpq-dev`](https://www.postgresql.org/docs/devel/libpq.html). Also known as
2020
`libpq-devel` on some systems.
2121
- [`docker`](https://www.docker.com/). Some tests need docker installed and **running**.
2222

book/src/validator-manager-create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,4 +201,4 @@ Duplicate validators are ignored, ignoring 0xab6e29f1b98fedfca878edce2b471f1b5ee
201201
Re-uploaded keystore 1 of 6 to the VC
202202
```
203203

204-
The guide is complete.
204+
The guide is complete.

book/src/voluntary-exit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ In order to initiate an exit, users can use the `lighthouse account validator ex
1616

1717
- The `--keystore` flag is used to specify the path to the EIP-2335 voting keystore for the validator. The path should point directly to the validator key `.json` file, _not_ the folder containing the `.json` file.
1818

19-
- The `--beacon-node` flag is used to specify a beacon chain HTTP endpoint that confirms to the [Beacon Node API](https://ethereum.github.io/beacon-APIs/) specifications. That beacon node will be used to validate and propagate the voluntary exit. The default value for this flag is `http://localhost:5052`.
19+
- The `--beacon-node` flag is used to specify a beacon chain HTTP endpoint that conforms to the [Beacon Node API](https://ethereum.github.io/beacon-APIs/) specifications. That beacon node will be used to validate and propagate the voluntary exit. The default value for this flag is `http://localhost:5052`.
2020

2121
- The `--network` flag is used to specify the network (default is `mainnet`).
2222

0 commit comments

Comments
 (0)