Просмотр исходного кода

docs: Reducing duplicate parts of the tor/i2p/nym sub-chapters, by creating a common reference point in public-guide.md

- Added 'Common Setup Steps' section to public-guide.md as point of reference
- Replaced duplicated sections in tor/i2p/nym guides with cross-references in the public-guide section
eliedinner561 6 месяцев назад
Родитель
Сommit
e2d8059131

+ 3 - 18
doc/src/misc/nodes/i2p-guide.md

@@ -11,16 +11,7 @@ for the seed nodes you connect to.
 
 ## Generating configuration files
 
-After compiling, you can start the application so it can spawn its configuration 
-file. We use `darkirc` as the application example going forward.
-
-```shell
-% ./darkirc
-```
-
-`darkirc` creates a configuration file `darkirc_config.toml` by default in 
-`~/.config/darkfi/`. You will review and edit this configuration file for your 
-preferred network settings. 
+For configuration file generation, see [Common Setup Steps](public-guide.md#generating-configuration-files). 
 
 ## Configure network settings
 
@@ -123,14 +114,8 @@ inbound = ["tcp://127.0.0.1:25551"]
 
 ## Connect and test your node
 
-Run `./darkirc`. Welcome to the dark forest.
-
-You can test if your node is configured properly on the network. Use 
-[Dnet](../../learn/dchat/network-tools/using-dnet.md) and the 
-[ping-tool](../network-troubleshooting.md#ping-tool) to test your node 
-connections. You can view if your node is making inbound and outbound connections.
+See [Common Setup Steps → Connect and test your node](public-guide.md#connect-and-test-your-node).
 
 ## Troubleshooting
 
-Refer to [Network troubleshooting](../network-troubleshooting.md)
-for further troubleshooting resources.
+See [Common Setup Steps → Troubleshooting](public-guide.md#troubleshooting).

+ 3 - 20
doc/src/misc/nodes/nym-guide.md

@@ -16,17 +16,7 @@ connect to.
 
 ## Generating configuration files
 
-After compiling, you can start the application so it can spawn its
-configuration file. We use `darkirc` as the application example going
-forward.
-
-```shell
-% ./darkirc
-```
-
-`darkirc` creates a configuration file `darkirc_config.toml` by default
-in `~/.config/darkfi/`. You will review and edit this configuration
-file for your preferred network settings.
+For configuration file generation, see [Common Setup Steps](public-guide.md#generating-configuration-files).
 
 ## Configure network settings
 
@@ -88,18 +78,11 @@ seeds = [
 
 ## Connect and test your node
 
-Run `./darkirc`. Welcome to the dark forest.
-
-You can test if your node is configured properly on the network. Use
-[Dnet](../../learn/dchat/network-tools/using-dnet.md) and the
-[ping-tool](../network-troubleshooting.md#ping-tool) to test your node
-connections. You can view if your node is making inbound and outbound
-connections.
+See [Common Setup Steps → Connect and test your node](public-guide.md#connect-and-test-your-node).
 
 ## Troubleshooting
 
-Refer to [Network troubleshooting](../network-troubleshooting.md)
-for further troubleshooting resources.
+See [Common Setup Steps → Troubleshooting](public-guide.md#troubleshooting).
 
 ## Running a Nym Network Requester
 _You can run a `Nym Network Requester` to support the Darkfi P2P

+ 21 - 22
doc/src/misc/nodes/public-guide.md

@@ -8,25 +8,36 @@ explains how to run the optimal DarkFi public node configurations.
 <u><b>Note</b></u>: If you do not want your IP address to be public you can run 
 a node using Tor.
 
-<u><b>Note</b></u>: This page is a general guide for public nodes in the DarkFi 
-ecosystem and is applicable to other apps such as `taud` and `darkfid`. We use 
+<u><b>Note</b></u>: This page is a general guide for public nodes in the DarkFi
+ecosystem and is applicable to other apps such as `taud` and `darkfid`. We use
 `darkirc` as our main example throughout this guide. Commands such as `./darkirc`
 and configuration filenames need to be adjusted if using different apps.
-If you're using another app, the network configurations remain the same except 
-for the seed nodes you connect to. 
+If you're using another app, the network configurations remain the same except
+for the seed nodes you connect to.
 
-## Generating configuration files
+## Common Setup Steps
 
-After compiling, you can start the application so it can spawn its configuration 
-file. We use `darkirc` as the application example going forward.
+### Generating configuration files
+
+After compiling, you can start the application so it can spawn its configuration file. We use `darkirc` as the application example going forward.
 
 ```shell
 % ./darkirc
 ```
 
-`darkirc` creates a configuration file `darkirc_config.toml` by default in 
-`~/.config/darkfi/`. You will review and edit this configuration file for your 
-preferred network settings. 
+`darkirc` creates a configuration file `darkirc_config.toml` by default in `~/.config/darkfi/`. You will review and edit this configuration file for your preferred network settings.
+
+## Connect and test your node
+
+Run ./darkirc. Welcome to the dark forest.
+
+You can test if your node is configured properly on the network. Use [Dnet](../../learn/dchat/network-tools/using-dnet.md) and the [ping-tool](../network-troubleshooting.md#ping-tool) to test your node connections. You can view if your node is making inbound and outbound connections.
+
+### Troubleshooting
+
+Refer to [Network troubleshooting](../network-troubleshooting.md) for further troubleshooting resources.
+
+---
 
 ## Configure your network settings
 
@@ -282,15 +293,3 @@ seeds = [
     "tor://yvklzjnfmwxhyodhrkpomawjcdvcaushsj6torjz2gyd7e25f3gfunyd.onion:25552",
 ]
 ```
-
-## Test your node
-
-You can test if your node is configured properly on the network. Use 
-[Dnet](../../learn/dchat/network-tools/using-dnet.md) and the
-[ping-tool](../network-troubleshooting.md#ping-tool) to test your node
-connections. You can view if your node is making inbound and outbound connections.
-
-## Troubleshooting
-
-Refer to [Network troubleshooting](../network-troubleshooting.md)
-for further troubleshooting resources.

+ 3 - 19
doc/src/misc/nodes/tor-guide.md

@@ -13,16 +13,7 @@ except for the seed nodes (ports) you connect to.
 
 ## Generating configuration files
 
-After compiling, you can start the application so it can spawn its
-configuration file.
-
-```shell
-% ./darkirc
-```
-
-`darkirc` creates a configuration file `darkirc_config.toml` by default
-in `~/.config/darkfi/`. You will review and edit this configuration file
-for your preferred network settings. 
+For configuration file generation, see [Common Setup Steps](public-guide.md#generating-configuration-files). 
 
 ## Configure network settings
 
@@ -175,15 +166,8 @@ inbound = ["tcp://127.0.0.1:9601"]
 
 ## Connect and test your node
 
-Run `./darkirc`. Welcome to the dark forest.
-
-You can test if your node is configured properly on the network. Use 
-[Dnet](../../learn/dchat/network-tools/using-dnet.md) and the 
-[ping-tool](../network-troubleshooting.md#ping-tool) to test your node 
-connections. You can view if your node is making inbound and outbound
-connections.
+See [Common Setup Steps → Connect and test your node](public-guide.md#connect-and-test-your-node).
 
 ## Troubleshooting
 
-Refer to [Network troubleshooting](../network-troubleshooting.md)
-for further troubleshooting resources.
+See [Common Setup Steps → Troubleshooting](public-guide.md#troubleshooting).