Pārlūkot izejas kodu

doc: update character formatting for network-troubleshooting and philosophy doc

darkfi 1 gadu atpakaļ
vecāks
revīzija
aec8118b85

+ 36 - 13
doc/src/misc/network-troubleshooting.md

@@ -1,12 +1,18 @@
 # Network troubleshooting
 
-If you're having network issues, refer to this page to debug various issues. If you see inconsistencies in the docs: always trust bin/darkirc/darkirc_config.toml or whichever respective apps' repo config file. Documentation updates are a current WIP.
+If you're having network issues, refer to this page to debug various 
+issues. If you see inconsistencies in the docs: always trust 
+`bin/darkirc/darkirc_config.toml` or whichever respective apps' repo
+config file. Documentation updates are a current WIP.
 
 The default location for config files is `~/.config/darkfi`
 
 ## Check liveness of seed nodes
 
-Use the `ping` tool to check if your node can access the seeds on the network. To access the `ping` tool, in the `~/darkfi/script/ping` directory run `cargo run main.rs`. Once completed, you can now use the `ping` tool in the `~/darkfi/script/ping/target/debug` directory. 
+Use the `ping` tool to check if your node can access the seeds on the
+network. To access the `ping` tool, in the `~/darkfi/script/ping` 
+directory run `cargo run main.rs`. Once completed, you can now use the 
+`ping` tool in the `~/darkfi/script/ping/target/debug` directory. 
 
 Ping tcp seeds located in your config file
 ```
@@ -26,31 +32,39 @@ If these work, then your node is connected to seeds on the network.
 
 ## dnet
 
-dnet is a simple tui to explore darkfi p2p network topology. You can use dnet to gather more network information. dnet displays:
+dnet is a simple tui to explore darkfi p2p network topology. You can use 
+dnet to gather more network information. dnet displays:
 1. Active p2p nodes
 2. Outgoing, incoming, manual and seed sessions
 3. Each associated connection and recent messages.
 
 To install dnet, go [here](https://codeberg.org/darkrenaissance/darkfi/src/branch/master/bin/dnet/README.md#run).
-You can use dnet to view the network topology and see how your node interacts within the network. dnet log information is created in `bin/dnet/dnet.log`
+You can use dnet to view the network topology and see how your node 
+interacts within the network. dnet log information is created in `bin/dnet/dnet.log`
 
 
 ## Inbound
 
-To see if your address is reachable to others in the network, you'll need to use separate device to `ping` your external address. 
+To see if your address is reachable to others in the network, you'll need 
+to use separate device to `ping` your external address. 
 [Generate an external address here](https://darkrenaissance.github.io/darkfi/clients/tor_inbound.html?highlight=tor#1-install-tor).
-For example purposes, let's assume your external address is `jamie3vkiwibfiwucd6vxijskbhpjdyajmzeor4mc4i7yopvpo4p7cyd.onion`. `ping` your generated external address from a separate device. 
+For example purposes, let's assume your external address is 
+`jamie3vkiwibfiwucd6vxijskbhpjdyajmzeor4mc4i7yopvpo4p7cyd.onion`. 
+`ping` your generated external address from a separate device. 
 ```
 $ ./ping jamie3vkiwibfiwucd6vxijskbhpjdyajmzeor4mc4i7yopvpo4p7cyd.onion
 ```
 If your external address is reachable, you'll receive a `Connected!` prompt
 
 ## Check tor connection
-You can verify if your local node is running over Tor. Execute this command in `~/darkfi/script`. You'll need to install pysocks `pip install pysocks` prior to running `tor-test.py` the first time.
+You can verify if your local node is running over Tor. Execute this 
+command in `~/darkfi/script`. You'll need to install pysocks 
+`pip install pysocks` prior to running `tor-test.py` the first time.
 ```
 $ python3 tor-test.py 
 ```
-If your local node is running Tor, the response should be an IP address. An error will return if Tor isn't running.
+If your local node is running Tor, the response should be an IP address.
+An error will return if Tor isn't running.
 
 ### Helpful debug information
 
@@ -59,7 +73,8 @@ If you're looking to debug an issue, try these helpful tools
 ## Logs in debug mode
 
 When looking for log information refer to the respective apps' config file. 
-Change the following settings in the configuration file, `~/.config/darkirc/darkirc_config.toml` in this example
+Change the following settings in the configuration file, 
+`~/.config/darkirc/darkirc_config.toml` in this example
 
 ```toml
 # Log to file. Off by default.
@@ -69,11 +84,15 @@ verbose = 2
 ```
 ## Config file
 
-Your config files are generated in your `~/.config/darkirc` directory. You'll have to run each daemon once for the app to spawn a config file, which you can review and edit. There is also helpful information within the config files.
+Your config files are generated in your `~/.config/darkirc` directory. 
+You'll have to run each daemon once for the app to spawn a config file, 
+which you can review and edit. There is also helpful information within 
+the config files.
 
 ## Node information script
 
-If you're looking for information about your node, including inbound, outbound, and seed connections, execute this command in `~/darkfi/script`
+If you're looking for information about your node, including inbound, 
+outbound, and seed connections, execute this command in `~/darkfi/script`
 ```
 $ python3 node_get-info.py
 ```
@@ -82,6 +101,10 @@ $ python3 node_get-info.py
 
 If you receive DAG sync issues, verify:
 1. a hostlist is set in the config file of the respective app.
-2. There are hosts in the hostlists (you should get hostlists from the default seed on the first run). You can find the hostlist files within the respective apps' repo. For example darkirc's default hostlist location is `~/.local/darkfi/darkirc/hostlist.tsv`
+2. There are hosts in the hostlists (you should get hostlists from the 
+default seed on the first run). You can find the hostlist files within 
+the respective apps' repo. For example darkirc's default hostlist location 
+is `~/.local/darkfi/darkirc/hostlist.tsv`
 
-If you are running MacOS, you should [use tor](https://darkrenaissance.github.io/darkfi/clients/tor_inbound.html?highlight=tor#hosting-anonymous-nodes).
+If you are running MacOS, you should 
+[use tor](https://darkrenaissance.github.io/darkfi/clients/tor_inbound.html?highlight=tor#hosting-anonymous-nodes).

+ 4 - 1
doc/src/philosophy/philosophy.md

@@ -219,7 +219,10 @@ to enact their vision and put their ideas into practice.
 
 ## Philosophy Meetings
 
-Every other Wednesday at 16:00 CET, there is a meeting on [darkirc](https://darkrenaissance.github.io/darkfi/misc/darkirc/darkirc.html) in `#philosophy`.  Come and discuss different philosophy texts with fellow community members.
+Every other Wednesday at 16:00 CET, there is a meeting on 
+[darkirc](https://darkrenaissance.github.io/darkfi/misc/darkirc/darkirc.html) in 
+`#philosophy`.  Come and discuss different philosophy texts with fellow
+community members.
 
 <!-- TODO:
 - liberal vs expansive democracy