Updated copy, fixed typos, merged docs

cmd/configure/configure.go

@@ -55,7 +55,7 @@ func configureNode() error {
 
 	// Check systemctl first
 	if algod.IsService() {
-		if promptWrapperYes("Algorand is installed as a service. Do you wish to edit the service file to change the data directory? (y/n)") {
+		if promptWrapperYes("Algorand is installed as a service. Do you wish to edit the service file to change the data directory? (Y/N)") {
 			// Edit the service file with the user's new data directory
 			systemServiceConfigure = true
 		} else {
@@ -84,18 +84,18 @@ func configureNode() error {
 			fmt.Println("Found valid Algorand Data Directory: " + algorandData)
 
 			if systemServiceConfigure {
-				if promptWrapperYes("Would you like to set the ALGORAND_DATA env variable as the data directory for the systemd Algorand service? (y/n)") {
+				if promptWrapperYes("Would you like to set the ALGORAND_DATA env variable as the data directory for the systemd Algorand service? (Y/N)") {
 					editAlgorandServiceFile(algorandData)
 					os.Exit(0)
 				}
 			}
 
-			if promptWrapperNo("Do you want to set a completely new data directory? (y/n)") {
+			if promptWrapperNo("Do you want to set a completely new data directory? (Y/N)") {
 				fmt.Println("User chose not to set a completely new data directory.")
 				os.Exit(0)
 			}
 
-			if promptWrapperYes("Do you want to manually input the new data directory? (y/n)") {
+			if promptWrapperYes("Do you want to manually input the new data directory? (Y/N)") {
 				newPath := promptWrapperInput("Enter the new data directory path")
 
 				if !validateAlgorandDataDir(newPath) {
@@ -130,7 +130,7 @@ func configureNode() error {
 		}
 
 		if len(paths) == 1 {
-			if promptWrapperYes("Do you want to set this directory as the new data directory? (y/n)") {
+			if promptWrapperYes("Do you want to set this directory as the new data directory? (Y/N)") {
 				if systemServiceConfigure {
 					// Edit the service file
 					editAlgorandServiceFile(paths[0])
@@ -142,7 +142,7 @@ func configureNode() error {
 
 		} else {
 
-			if promptWrapperYes("Do you want to set one of these directories as the new data directory? (y/n)") {
+			if promptWrapperYes("Do you want to set one of these directories as the new data directory? (Y/N)") {
 
 				selectedPath := promptWrapperSelection("Select an Algorand data directory", paths)
 
@@ -158,12 +158,12 @@ func configureNode() error {
 	}
 
 	// Deep search
-	if promptWrapperNo("Do you want NodeKit to do a deep search for pre-existing Algorand Data directories? (y/n)") {
-		fmt.Println("User chose not to search for more pre-existing Algorand Data directories. Exiting...")
+	if promptWrapperNo("Do you want NodeKit to do a deep search for pre-existing Algorand data directories? (Y/N)") {
+		fmt.Println("User chose not to search for more pre-existing Algorand data directories. Exiting...")
 		os.Exit(0)
 	}
 
-	fmt.Println("Searching for pre-existing Algorand Data directories in HOME directory...")
+	fmt.Println("Searching for pre-existing Algorand data directories in HOME directory...")
 	paths = deepSearchAlgorandDataDirs()
 
 	if len(paths) == 0 {

docs/astro.config.mjs

@@ -1,37 +1,37 @@
 // @ts-check
-import { defineConfig } from 'astro/config';
-import starlight from '@astrojs/starlight';
-import tailwind from '@astrojs/tailwind';
+import { defineConfig } from "astro/config";
+import starlight from "@astrojs/starlight";
+import tailwind from "@astrojs/tailwind";
 
 // https://astro.build/config
 export default defineConfig({
-	integrations: [
-		starlight({
-			title: 'NodeKit',
-			logo: {
-				src: './public/nodekit.png',
-				replacesTitle: true,
-			},
-			social: {
-				github: 'https://github.com/algorandfoundation/nodekit',
-			},
-			sidebar: [
-				{
-					label: 'Guides',
-					autogenerate: { directory: 'guides' },
-				},
-				{
-					label: 'Troubleshooting',
-					autogenerate: { directory: 'troubleshooting' },
-				},
-				{
-					label: 'Command Reference',
-					collapsed: true,
-					autogenerate: { directory: 'reference' },
-				},
-			],
-			customCss: ['./src/tailwind.css'],
-		}),
-		tailwind({ applyBaseStyles: true }),
-	],
+  integrations: [
+    starlight({
+      title: "NodeKit",
+      logo: {
+        src: "./public/nodekit.png",
+        replacesTitle: true,
+      },
+      social: {
+        github: "https://github.com/algorandfoundation/nodekit",
+      },
+      sidebar: [
+        {
+          label: "Guides",
+          autogenerate: { directory: "guides" },
+        },
+        {
+          label: "Troubleshooting",
+          link: "/troubleshooting",
+        },
+        {
+          label: "Command Reference",
+          collapsed: true,
+          autogenerate: { directory: "reference" },
+        },
+      ],
+      customCss: ["./src/tailwind.css"],
+    }),
+    tailwind({ applyBaseStyles: true }),
+  ],
 });

docs/src/content/docs/guides/20-bootstrap.md → docs/src/content/docs/guides/bootstrap.md

@@ -1,50 +1,52 @@
 ---
-title: Installing and bootstrapping the Algorand node
+title: Bootstrapping the Algorand node
 description: Installing and bootstrapping the Algorand node
+sidebar:
+  order: 20
 ---
 
 ## How to start the process
 
-The bootstrap process is automatically started after following the [nodekit installation instructions](/guides/10-getting-started), but it can also be triggered manually by running this command:
+The bootstrap process is automatically started after following the [NodeKit installation instructions](/guides/getting-started), but it can also be triggered manually by running this command:
 
 ```bash
 ./nodekit bootstrap
 ```
 
 ## Prompts: Installation and Fast-catchup
 
-Nodekit bootstrap will check to see if there is a node already installed.
+`nodekit bootstrap` will check to see if there is a node already installed.
 
 If there is none, it will ask if you want to start a node installation:
 
 > Installing A Node
 >
-> It looks like you're running this for the first time. Would you like to install a node? (Y/n)
+> It looks like you're running this for the first time. Would you like to install a node? (Y/N)
 
-You can respond by pressing the `y` or `n` keys of your keyboard, for `yes` and `no` respectively.
+You can respond by pressing the `Y` or `N` keys of your keyboard, for `Yes` and `No` respectively.
 
 ---
 
 It will then ask if you want to perform a "fast-catchup" with the network:
 
 > Regular sync with the network usually takes multiple days to weeks. You can optionally perform fast-catchup to sync in 30-60 minutes instead.
 >
-> Would you like to preform a fast-catchup after installation? (Y/n)
+> Would you like to preform a fast-catchup after installation? (Y/N)
 
 Fast-catchup saves a lot of time, so we recommend responding Yes.
 
 ---
 
-Assuming you have responded "yes" to the node install prompt, you will now be prompted for your user password:
+Assuming you have responded "Yes" to the node install prompt, you will now be prompted for your user password:
 
 ```
 WARN (You may be prompted for your password)
 INFO Installing Algod on Linux
 INFO Installing with apt-get
-[sudo] password for user: 
+[sudo] password for user:
 ```
 
-Your operating system requires this to allow Nodekit to install the Algorand node software. Enter your user password and press ENTER to proceed.
+Your operating system requires this to allow NodeKit to install the Algorand node software. Enter your user password and press ENTER to proceed.
 
 ## Installation
 
@@ -56,7 +58,7 @@ The installation phase should only take a few minutes. Your terminal will look l
 
 ## Fast catchup
 
-After installation is complete, Nodekit will automatically start the Nodekit user interface.
+After installation is complete, NodeKit will automatically start the NodeKit user interface.
 
 This will display the progress of catching up to the latest state of the Algorand network:
 
@@ -70,5 +72,5 @@ When the process is done, the Fast Catchup status information will disappear and
 
 :::note
 **Did you encounted any errors?**
-Check out the [Troubleshooting: Installing and bootstrapping the Algorand node](/troubleshooting/20-bootstrap) section.
+Check out the [Troubleshooting: Installing and bootstrapping the Algorand node](/troubleshooting#bootstrapping-the-algorand-node) section.
 :::

docs/src/content/docs/guides/30-generate-participation-keys.md → docs/src/content/docs/guides/generate-participation-keys.md

@@ -1,9 +1,11 @@
 ---
 title: Generating participation keys
-description: Generating participation keys with nodekit
+description: Generating participation keys with NodeKit
+sidebar:
+  order: 30
 ---
 
-If it is not running already, start nodekit with this command:
+If it is not running already, start NodeKit with this command:
 
 ```bash
 ./nodekit
@@ -19,21 +21,21 @@ You will only be able to generate participation keys after your node is in a `RU
 
 Press the `G` key to start generating participation keys.
 
-Nodekit will ask the account address that you will be participating in consensus:
+NodeKit will ask the account address that you will be participating in consensus:
 
 ![](/assets/nodekit-partkey-gen-1.png)
 
 Enter your account address and press ENTER
 
 ## Select participation key duration
 
-Nodekit will ask the number of days that the participation keys will be valid for:
+NodeKit will ask the number of days that the participation keys will be valid for:
 
 ![](/assets/nodekit-partkey-gen-2.png)
 
-You can press the S key to cycle through duration modes in days / months / rounds.
+You can press the `S` key to cycle through duration modes in days / months / rounds.
 
-The longer your duration, the longer the participation key generation step will take to complete. 
+The longer your duration, the longer the participation key generation step will take to complete.
 
 ## Key generation
 
@@ -45,15 +47,15 @@ The time required for this step will depend on your participation key duration.
 
 ## Done
 
-When your participation keys are ready, Nodekit will display the key information as shown below.
+When your participation keys are ready, nodekit will display the key information as shown below.
 
 ![](/assets/nodekit-partkey-gen-4.png)
 
 You are now one step away from participating in Algorand consensus!
 
-As the on screen message indicates, you can press R to start [Registering your keys](/guides/40-register-online).
+As the on screen message indicates, you can press `R` to start [Registering your keys](/guides/register-online).
 
 :::note
 **Did you encounted any errors?**
-Check out the [Troubleshooting: Generating participation keys](/troubleshooting/30-generate-participation-keys) section.
+Check out the [Troubleshooting: Generating participation keys](/troubleshooting#generating-participation-keys) section.
 :::

docs/src/content/docs/guides/10-getting-started.md → docs/src/content/docs/guides/getting-started.md

@@ -1,32 +1,34 @@
 ---
-title: Getting Started
-description: Installing nodekit
+title: Getting Started with NodeKit
+description: Installing NodeKit
+sidebar:
+  order: 10
 ---
 
-Welcome to Nodekit, your command-line one-stop-shop for Algorand node running.
+Welcome to NodeKit, your command-line one-stop-shop for Algorand node running.
 
-Nodekit can help you with:
+NodeKit can help you with:
 
 - Installing and configuring an Algorand node
 - Syncing your node with the latest state of the network
 - Managing consensus participation keys
 - Monitoring your node and the network
 
-To get started with Nodekit, copy-paste this command in your terminal:
+To get started with NodeKit, copy-paste this command in your terminal:
 
 ```bash
 curl -fsSL https://nodekit.run/install.sh | bash
 ```
 
-This will detect your operating system and download the appropriate nodekit executable to your local directory.
+This will detect your operating system and download the appropriate NodeKit executable to your local directory.
 
 It will then immediately start the bootstrap process to get your Algorand node up and running:
 
-![Screenshot of a typical Nodekit installation process](/assets/nodekit-install.png)
+![Screenshot of a typical NodeKit installation process](/assets/nodekit-install.png)
 
 :::note
-**Did you encounted any errors?**
-Check out the [Troubleshooting: Getting Started](/troubleshooting/10-getting-started) section.
+**Did you encounter any errors?**
+Check out the [Troubleshooting: Getting Started](/troubleshooting#getting-started-with-nodekit) section.
 :::
 
 Otherwise, read on for guidance on the bootstrapping process.

docs/src/content/docs/guides/50-navigating-accounts-and-keys.md → docs/src/content/docs/guides/navigating-accounts-and-keys.md

@@ -1,6 +1,8 @@
 ---
-title: Navigating accounts and keys in Nodekit
-description: Navigating accounts and keys in Nodekit
+title: Navigating accounts and keys
+description: Navigating accounts and keys in NodeKit
+sidebar:
+  order: 50
 ---
 
 If it is not running already, start nodekit with this command:
@@ -28,4 +30,3 @@ Press `ENTER` to view the key information.
 From this screen, you can press `ESC` to return back to they keys list, `D` to delete a participation key, or `R` to register your key online or offline.
 
 ![](/assets/nodekit-navigate-keys.gif)
-

docs/src/content/docs/guides/40-register-online.md → docs/src/content/docs/guides/register-online.md

@@ -1,11 +1,13 @@
 ---
 title: Registering your keys online
-description: Registering your participation keys online with nodekit
+description: Registering your participation keys online with NodeKit
+sidebar:
+  order: 40
 ---
 
 After generating a participation key, you can press `R` to start registering it on the Algorand network.
 
-You can also start this flow by pressing `R` on the [key information screen](/50-navigating-accounts-and-keys/) shown below.
+You can also start this flow by pressing `R` on the [key information screen](/navigating-accounts-and-keys/) shown below.
 
 ![](/assets/nodekit-key-info.png)
 
@@ -21,22 +23,22 @@ You will be taken to the Lora Transaction Wizard, where you should see the key i
 
 ![](/assets/lora-keyreg.png)
 
-Now you need to:
+Next you need to:
 
 1. Select `Connect Wallet` on the top right and connect your wallet.
 
 2. Cick the `Send` button on the bottom right. Your wallet should prompt you to sign the key registration transaction
 
 3. Sign the transaction
 
-The transaction will be submitted to the network. If it is accepted successfully, you will see a visual confirmation in Lora like the one displayed below:
+The transaction will be submitted to the network. If it is accepted, you will see a visual confirmation in Lora similar to the one displayed below:
 
 ![](/assets/lora-txn-ok.png)
 
-Nodekit will detect the key registration and take you back to the Key information view:
+NodeKit will detect the key registration and take you back to the Key information view:
 
 ![](/assets/nodekit-keyreg-success.png)
 
 You can press `ESC` to leave the key information modal.
 
-That was it! Your node is now participating in Algorand consensus. If your account balance is over 30,000 ALGO, it will accumulate rewards for each block it proposes on the Algorand network.
+That's it! Your node is now participating in Algorand consensus. If your account balance is over 30,000 ALGO, it will accumulate rewards for each block it proposes on the Algorand network.