From aa592853df823778aedcd636ad54e4c7b1856450 Mon Sep 17 00:00:00 2001 From: joao <22820692+joaolago1113@users.noreply.github.com> Date: Wed, 20 Mar 2024 06:44:44 +0000 Subject: [PATCH] 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 6b0781682b4f9d129d9af48d428353f596b8b852. * Revert "fix minor typographical error: change 'advice' to 'advise' in SIGILL warning message" This reverts commit a4904a0afd2d531caf4585e1f0726a6dd65081ea. * compiled * Revert "compiled" This reverts commit 425a553bd93af93340858050cc45041ae86b3733. * Revert "Revert "compiled"" This reverts commit b1f871cb1bd41822f4c7bd696f77ba38cdd32f9d. * Empty commit to trigger CI. --- README.md | 2 +- account_manager/README.md | 4 ++-- book/src/lighthouse-ui.md | 4 ++-- book/src/setup.md | 2 +- book/src/validator-manager-create.md | 2 +- book/src/voluntary-exit.md | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ade3bc2ab..11a87b81f 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ as the canonical staking deposit contract address. The [Lighthouse Book](https://lighthouse-book.sigmaprime.io) contains information for users and developers. -The Lighthouse team maintains a blog at [lighthouse-blog.sigmaprime.io][blog] which contains periodical +The Lighthouse team maintains a blog at [lighthouse-blog.sigmaprime.io][blog] which contains periodic progress updates, roadmap insights and interesting findings. ## Branches diff --git a/account_manager/README.md b/account_manager/README.md index 6762b937f..cd303718a 100644 --- a/account_manager/README.md +++ b/account_manager/README.md @@ -29,6 +29,6 @@ Simply run `./account_manager generate` to generate a new random private key, which will be automatically saved to the correct directory. If you prefer to use our "deterministic" keys for testing purposes, simply -run `./accounts_manager generate_deterministic -i `, where `index` is +run `./account_manager generate_deterministic -i `, where `index` is the validator index for the key. This will reliably produce the same key each time -and save it to the directory. \ No newline at end of file +and save it to the directory. diff --git a/book/src/lighthouse-ui.md b/book/src/lighthouse-ui.md index 4182314da..81098715f 100644 --- a/book/src/lighthouse-ui.md +++ b/book/src/lighthouse-ui.md @@ -13,7 +13,7 @@ Siren is a user interface built for Lighthouse that connects to a Lighthouse Bea a Lighthouse Validator Client to monitor performance and display key validator metrics. -The UI is currently in active development. Its resides in the +The UI is currently in active development. It resides in the [Siren](https://github.com/sigp/siren) repository. ## Topics @@ -30,5 +30,5 @@ information: ## Contributing -If you find and issue or bug or would otherwise like to help out with the +If you find an issue or bug or would otherwise like to help out with the development of the Siren project, please submit issues and PRs to the [Siren](https://github.com/sigp/siren) repository. diff --git a/book/src/setup.md b/book/src/setup.md index 87f431f9b..c678b4387 100644 --- a/book/src/setup.md +++ b/book/src/setup.md @@ -16,7 +16,7 @@ The additional requirements for developers are: some dependencies. See [`Installation Guide`](./installation.md) for more info. - [`java 17 runtime`](https://openjdk.java.net/projects/jdk/). 17 is the minimum, used by web3signer_tests. -- [`libpq-dev`](https://www.postgresql.org/docs/devel/libpq.html). Also know as +- [`libpq-dev`](https://www.postgresql.org/docs/devel/libpq.html). Also known as `libpq-devel` on some systems. - [`docker`](https://www.docker.com/). Some tests need docker installed and **running**. diff --git a/book/src/validator-manager-create.md b/book/src/validator-manager-create.md index 6ba894a43..98202d3b5 100644 --- a/book/src/validator-manager-create.md +++ b/book/src/validator-manager-create.md @@ -201,4 +201,4 @@ Duplicate validators are ignored, ignoring 0xab6e29f1b98fedfca878edce2b471f1b5ee Re-uploaded keystore 1 of 6 to the VC ``` -The guide is complete. \ No newline at end of file +The guide is complete. diff --git a/book/src/voluntary-exit.md b/book/src/voluntary-exit.md index 8e8a39a95..4ec4837fe 100644 --- a/book/src/voluntary-exit.md +++ b/book/src/voluntary-exit.md @@ -16,7 +16,7 @@ In order to initiate an exit, users can use the `lighthouse account validator ex - 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. -- 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`. +- 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`. - The `--network` flag is used to specify the network (default is `mainnet`).