Fix some panel docs links and formatting (#110)

Co-authored-by: Thomas Kellerman
vicariousdrama · Mar 23, 2023 · f967985 · f967985
1 parent 5aaf623
commit f967985
Show file tree

Hide file tree

Showing 33 changed files with 265 additions and 533 deletions.
diff --git a/_docs/script-arthash.md b/_docs/script-arthash.md
@@ -13,23 +13,18 @@ This script produces geometric artwork deterministically based on Bitcoin
 Blockhash values. It depends on a bitcoin node running locally and fully
 synched.
 
-
 ![sample image depicting hash as colored triangles](../images/arthash-719360.png)
 
 ## Script Location
 
 The script is installed at 
-[../scripts/arthash.py](../scripts/arthash.py). 
+[~/nodeyez/scripts/arthash.py](../scripts/arthash.py). 
 
 ## Configuration
 
-To configure this script
-
-Override the default configuration as follows
+To configure this script, edit the `~/nodeyez/config/arthash.json` file
 
-```sh
-nano ../config/arthash.json
-```
+Fields are defined below
 
 | field name | description |
 | --- | --- |
@@ -41,29 +36,25 @@ nano ../config/arthash.json
 | height | The height, in pixels, to generate the image. Default `320` |
 | sleepInterval | The amount of time, in seconds, the script should wait before data gathering and image creation again. Default `300` |
 
-After making changes, Save (CTRL+O) and Exit (CTRL+X) nano.
-
 ## Run Directly
 
-To run this script
-
 Ensure the virtual environment is activated
-
 ```shell
 source ~/.pyenv/nodeyez/bin/activate
 ```
 
-And then run it
-
+Change to the scripts folder
 ```shell
 cd ~/nodeyez/scripts
+```
 
+And run it
+```shell
 python arthash.py
 ```
 
 Press CTRL+C to stop the process
 
-
 ## Run at Startup
 
 To enable the script to run at startup, as the privileged user run the following
@@ -76,5 +67,4 @@ sudo systemctl start nodeyez-arthash.service
 
 ---
 
-[Home](../) | 
-
+[Home](../) | 
diff --git a/_docs/script-arthashdungeon.md b/_docs/script-arthashdungeon.md
@@ -20,15 +20,13 @@ synched.
 ## Script Location
 
 The script is installed at 
-[../scripts/arthashdungeon.py](../scripts/arthashdungeon.py). 
+[~/nodeyez/scripts/arthashdungeon.py](../scripts/arthashdungeon.py). 
 
 ## Configuration
 
-To configure this script, override the default configuration as follows
+To configure this script, edit the `~/nodeyez/config/arthashdungeon.json` file
 
-```shell
-nano ../config/arthashdungeon.json
-```
+Fields are defined below
 
 | field name | description |
 | --- | --- |
@@ -41,23 +39,20 @@ nano ../config/arthashdungeon.json
 | height | The height, in pixels, to generate the image. Default `320` |
 | sleepInterval | The amount of time, in seconds, the script should wait before data gathering and image creation again. Default `300` |
 
-After making changes, Save (CTRL+O) and Exit (CTRL+X) nano.
-
 ## Run Directly
 
-To run this script
-
 Ensure the virtual environment is activated
-
 ```shell
 source ~/.pyenv/nodeyez/bin/activate
 ```
 
-And then run it
-
+Change to the scripts folder
 ```shell
 cd ~/nodeyez/scripts
+```
 
+And run it
+```shell
 python arthashdungeon.py
 ```
 
@@ -75,5 +70,4 @@ sudo systemctl start nodeyez-arthashdungeon.service
 
 ---
 
-[Home](../) | 
-
+[Home](../) | 
diff --git a/_docs/script-blockheight.md b/_docs/script-blockheight.md
@@ -17,15 +17,13 @@ It depends on a bitcoin node running locally and fully synched.
 ## Script Location
 
 The script is installed at 
-[../scripts/blockheight.py](../scripts/blockheight.py).
+[~/nodeyez/scripts/blockheight.py](../scripts/blockheight.py).
 
 ## Configuration
 
-To configure this script override the default configuration as follows
+To configure this script, edit the `~/nodeyez/config/blockheight.json` file
 
-```shell
-nano ../config/blockheight.json
-```
+Fields are defined below
 
 | field name | description |
 | --- | --- |
@@ -36,23 +34,20 @@ nano ../config/blockheight.json
 | height | The height, in pixels, to generate the image. Default `320` |
 | sleepInterval | The amount of time, in seconds, the script should wait before data gathering and image creation again. Default `120` |
 
-After making changes, Save (CTRL+O) and Exit (CTRL+X) nano.
-
 ## Running Directly
 
-To run this script
-
 Ensure the virtual environment is activated
-
 ```shell
 source ~/.pyenv/nodeyez/bin/activate
 ```
 
-And then run it
-
+Change to the scripts folder
 ```shell
 cd ~/nodeyez/scripts
+```
 
+Run it
+```shell
 python blockheight.py
 ```
 

diff --git a/_docs/script-blockstats.md b/_docs/script-blockstats.md
@@ -28,15 +28,13 @@ An additional image can be produced to graph segwit prevalence over time
 ## Script Location
 
 The script is installed at 
-[../scripts/blockstats.py](../scripts/blockstats.py).
+[~/nodeyez/scripts/blockstats.py](../scripts/blockstats.py).
 
 ## Configuration
 
-To configure this script override the default configuration as follows
+To configure this script, edit the `~/nodeyez/config/blockstats.json` file
 
-```shell
-nano ../config/blockstats.json
-```
+Fields are defined below
 
 | field name | description |
 | --- | --- |
@@ -58,24 +56,20 @@ nano ../config/blockstats.json
 | showFeeRates | Indicates whether the fee rates image should be created. Default: `true` |
 | showSegwitPrevalence | Indicates whether the segwit prevalence image should be created. Default `true` |
 
-
-After making changes, Save (CTRL+O) and Exit (CTRL+X) nano.
-
 ## Running Directly
 
-To run this script
-
 Ensure the virtual environment is activated
-
 ```shell
 source ~/.pyenv/nodeyez/bin/activate
 ```
 
-And then run it
-
+Change to the scripts folder
 ```shell
 cd ~/nodeyez/scripts
+```
 
+Run it
+```shell
 python blockstats.py
 ```
 
@@ -93,5 +87,4 @@ sudo systemctl start nodeyez-blockstats.service
 
 ---
 
-[Home](../) | 
-
+[Home](../) | 
diff --git a/_docs/script-braiinspool.md b/_docs/script-braiinspool.md
@@ -24,15 +24,13 @@ from this panel in future updates.
 ## Script Location
 
 This script is installed at
-[../scripts/braiinspool.py](../scripts/braiinspool.py)
+[~/nodeyez/scripts/braiinspool.py](../scripts/braiinspool.py)
 
 ## Configuration
 
-To configure this script override the default configuration as follows
+To configure this script, edit the `~/nodeyez/config/braiinspool.json` file
 
-```shell
-nano ../config/braiinspool.json
-```
+Fields are defined below
 
 You must set the authtoken field with your API access token
 
@@ -61,23 +59,20 @@ You must set the authtoken field with your API access token
 | colorBreakEvenMiss | The color of the text showing the break even amount when it is not met expressed as a Hexadecimal color specifier. Default `#ff0000` |
 | colorBreakEvenGood | The color of the text showing the break even amount when it is met expressed as a Hexadecimal color specifier. Default `#00ff00` |
 
-After making changes, Save (CTRL+O) and Exit (CTRL+X) nano.
-
 ## Run Directly
 
-* To run this script
-
 Ensure the virtual environment is activated
-
 ```shell
 source ~/.pyenv/nodeyez/bin/activate
 ```
 
-And then run it
-
+Change to the scripts folder
 ```shell
 cd ~/nodeyez/scripts
+```
 
+Run it
+```shell
 python braiinspool.py
 ```
 
@@ -95,5 +90,4 @@ sudo systemctl start nodeyez-braiinspool.service
 
 ---
 
-[Home](../) | 
-
+[Home](../) | 
diff --git a/_docs/script-channelbalance.md b/_docs/script-channelbalance.md
@@ -19,16 +19,13 @@ It depends on a lighting node.
 ## Script Location
 
 The script is installed at 
-[../scripts/channelbalance.py](../scripts/channelbalance.py).
-
+[~/nodeyez/scripts/channelbalance.py](../scripts/channelbalance.py).
 
 ## Configuration
 
-To configure this script override the default configuration as follows
+To configure this script, edit the `~/nodeyez/config/channelbalance.json` file
 
-```shell
-nano ../config/channelbalance.json
-```
+Fields are defined below
 
 | field name | description |
 | --- | --- |
@@ -71,24 +68,21 @@ nano ../config/channelbalance.json
 | height | Override the height, in pixels, to generate the image. |
 | pageSize | Override the number of channels to represent per page rendered. |
 | headerText | Override the text to use in the header area. |
-
-After making changes, Save (CTRL+O) and Exit (CTRL+X) nano.
 
 ## Run Directly
 
-To run this script
-
 Ensure the virtual environment is activated
-
 ```shell
 source ~/.pyenv/nodeyez/bin/activate
 ```
 
-And then run it
-
+Change to the scripts folder
 ```shell
 cd ~/nodeyez/scripts
+```
 
+Run it
+```shell
 python channelbalance.py
 ```
 
@@ -106,5 +100,4 @@ sudo systemctl start nodeyez-channelbalance.service
 
 ---
 
-[Home](../) | 
-
+[Home](../) | 
diff --git a/_docs/script-channelfees.md b/_docs/script-channelfees.md
@@ -19,15 +19,13 @@ number of open channels.  It depends on a lighting node.
 ## Script Location
 
 The script is installed at 
-[../scripts/channelfees.py](../scripts/channelfees.py).
+[~/nodeyez/scripts/channelfees.py](../scripts/channelfees.py).
 
 ## Configuration
 
-To configure this script override the default configuration as follows
+To configure this script, edit the `~/nodeyez/config/channelfees.json` file
 
-```shell
-nano ../config/channelfees.json
-```
+Fields are defined below
 
 | field name | description |
 | --- | --- |
@@ -71,23 +69,20 @@ nano ../config/channelfees.json
 | pageSize | Override the number of channels to represent per page rendered. |
 | headerText | Override the text to use in the header area. |
 
-After making changes, Save (CTRL+O) and Exit (CTRL+X) nano.
-
 ## Run Directly
 
-To run this script
-
 Ensure the virtual environment is activated
-
 ```shell
 source ~/.pyenv/nodeyez/bin/activate
 ```
 
-And then run it
-
+Change to the scripts folder
 ```shell
 cd ~/nodeyez/scripts
+```
 
+Run it
+```shell
 python channelfees.py
 ```
 
@@ -105,5 +100,4 @@ sudo systemctl start nodeyez-channelfees.service
 
 ---
 
-[Home](../) | 
-
+[Home](../) |