From a0e64d065242d2973bb815f1ffb6128cf246e1b6 Mon Sep 17 00:00:00 2001 From: chonghe <44791194+chong-he@users.noreply.github.com> Date: Sun, 24 Mar 2024 04:52:09 +0800 Subject: [PATCH] Built-in documentation text width in Lighthouse book (#5394) * Adjust width * Commit changes * Trigger Build --- book/src/help_bn.md | 3 ++- book/src/help_general.md | 3 ++- book/src/help_vc.md | 3 ++- book/src/help_vm.md | 3 ++- book/src/help_vm_create.md | 3 ++- book/src/help_vm_import.md | 3 ++- book/src/help_vm_move.md | 3 ++- scripts/cli.sh | 3 +++ 8 files changed, 17 insertions(+), 7 deletions(-) diff --git a/book/src/help_bn.md b/book/src/help_bn.md index 488f4ac12..c0505988c 100644 --- a/book/src/help_bn.md +++ b/book/src/help_bn.md @@ -490,4 +490,5 @@ OPTIONS: Specify a weak subjectivity checkpoint in `block_root:epoch` format to verify the node's sync against. The block root should be 0x-prefixed. Note that this flag is for verification only, to perform a checkpoint sync from a recent state use --checkpoint-sync-url. -``` \ No newline at end of file +``` + diff --git a/book/src/help_general.md b/book/src/help_general.md index fbe05693e..551f93e2b 100644 --- a/book/src/help_general.md +++ b/book/src/help_general.md @@ -104,4 +104,5 @@ SUBCOMMANDS: blocks and attestations). [aliases: v, vc, validator] validator_manager Utilities for managing a Lighthouse validator client via the HTTP API. [aliases: vm, validator-manager, validator_manager] -``` \ No newline at end of file +``` + diff --git a/book/src/help_vc.md b/book/src/help_vc.md index 3d2519aac..fb963f87c 100644 --- a/book/src/help_vc.md +++ b/book/src/help_vc.md @@ -222,4 +222,5 @@ OPTIONS: --web3-signer-max-idle-connections Maximum number of idle connections to maintain per web3signer host. Default is unlimited. -``` \ No newline at end of file +``` + diff --git a/book/src/help_vm.md b/book/src/help_vm.md index fa08aa4f6..db01164a9 100644 --- a/book/src/help_vm.md +++ b/book/src/help_vm.md @@ -94,4 +94,5 @@ SUBCOMMANDS: move Uploads validators to a validator client using the HTTP API. The validators are defined in a JSON file which can be generated using the "create-validators" command. This command only supports validators signing via a keystore on the local file system (i.e., not Web3Signer validators). -``` \ No newline at end of file +``` + diff --git a/book/src/help_vm_create.md b/book/src/help_vm_create.md index 71db3cc59..2fa54265a 100644 --- a/book/src/help_vm_create.md +++ b/book/src/help_vm_create.md @@ -134,4 +134,5 @@ OPTIONS: -t, --testnet-dir Path to directory containing eth2_testnet specs. Defaults to a hard-coded Lighthouse testnet. Only effective if there is no existing database. -``` \ No newline at end of file +``` + diff --git a/book/src/help_vm_import.md b/book/src/help_vm_import.md index 3960a55f1..e6ff351da 100644 --- a/book/src/help_vm_import.md +++ b/book/src/help_vm_import.md @@ -98,4 +98,5 @@ OPTIONS: --vc-url A HTTP(S) address of a validator client using the keymanager-API. If this value is not supplied then a 'dry run' will be conducted where no changes are made to the validator client. [default: http://localhost:5062] -``` \ No newline at end of file +``` + diff --git a/book/src/help_vm_move.md b/book/src/help_vm_move.md index a89af437a..fe1d4c5ae 100644 --- a/book/src/help_vm_move.md +++ b/book/src/help_vm_move.md @@ -115,4 +115,5 @@ OPTIONS: if there is no existing database. --validators The validators to be moved. Either a list of 0x-prefixed validator pubkeys or the keyword "all". -``` \ No newline at end of file +``` + diff --git a/scripts/cli.sh b/scripts/cli.sh index 7ba98d08b..2767ed73c 100755 --- a/scripts/cli.sh +++ b/scripts/cli.sh @@ -17,6 +17,9 @@ write_to_file() { # We need to add the header and the backticks to create the code block. printf "# %s\n\n\`\`\`\n%s\n\`\`\`" "$program" "$cmd" > "$file" + + # Adjust the width of the help text and append to the end of file + sed -i -e '$a\'$'\n''' "$file" } CMD=./target/release/lighthouse