more reorg and dead links

nymtech · May 14, 2024 · e59ef01 · e59ef01
1 parent 098155f
commit e59ef01
Show file tree

Hide file tree

Showing 14 changed files with 45 additions and 26 deletions.
diff --git a/documentation/dev-portal/src/SUMMARY.md b/documentation/dev-portal/src/SUMMARY.md
@@ -1,36 +1,39 @@
 [//]: # (TODO change the URLs in the top handlebars)
 #
-# Summary
+# Start Here
 - [Introduction](introduction.md)
 
+[//]: # (this is where you pull in some stuff from the infrastructure section as well as a general approach to how to start )
+- [Development Overview](dev-overview.md)
+
 [//]: # (TODO see what you can take from here and put in the intro file )
   [//]: # (# Infrastructure)
   [//]: # ()
   [//]: # (- [What is Nym?]&#40;infrastructure/nym.md&#41;)
   [//]: # (- [Nym vs Other Systems]&#40;infrastructure/nym-vs-others.md&#41;)
   [//]: # (- [Node Types]&#40;infrastructure/node-types.md&#41;)
 
-[//]: # (TODO change this to something like 'where to get started and rewrite')
+[//]: # (TODO change this to something like 'where to get started' and extensively rewrite)
 # Integrations
 - [Integration Options](integrations/integration-options.md)
 - [Payment Integration](integrations/payment-integration.md)
 
 # SDKs
 - [Rust SDK](sdk/rust/rust.md)
   - [Interacting with Clients - Read First!](sdk/rust/readfirst.md)
-	- [Message Types](sdk/rust/message-types.md)
-	- [Message Helpers](sdk/rust/message-helpers.md)
-	- [Troubleshooting](sdk/rust/troubleshooting.md)
-	- [Examples](sdk/rust/examples.md)
-		- [Simple Send](sdk/rust/examples/simple.md)
-		- [Create and Store Keys](sdk/rust/examples/keys.md)
-		- [Manual Storage](sdk/rust/examples/storage.md)
-		- [Anonymous Replies](sdk/rust/examples/surbs.md)
-		- [Use Custom Network Topology](sdk/rust/examples/custom-network.md)
-		- [Socks Proxy](sdk/rust/examples/socks.md)
-		- [Split Send and Receive](sdk/rust/examples/split-send.md)
-		- [Testnet Bandwidth Cred](sdk/rust/examples/credential.md)
-		- [Example Cargo file](sdk/rust/examples/cargo.md)
+  - [Message Types](sdk/rust/message-types.md)
+  - [Message Helpers](sdk/rust/message-helpers.md)
+  - [Troubleshooting](sdk/rust/troubleshooting.md)
+  - [Examples](sdk/rust/examples.md)
+      - [Simple Send](sdk/rust/examples/simple.md)
+      - [Create and Store Keys](sdk/rust/examples/keys.md)
+      - [Manual Storage](sdk/rust/examples/storage.md)
+      - [Anonymous Replies](sdk/rust/examples/surbs.md)
+      - [Use Custom Network Topology](sdk/rust/examples/custom-network.md)
+      - [Socks Proxy](sdk/rust/examples/socks.md)
+      - [Split Send and Receive](sdk/rust/examples/split-send.md)
+      - [Testnet Bandwidth Cred](sdk/rust/examples/credential.md)
+      - [Example Cargo file](sdk/rust/examples/cargo.md)
 - [Typescript SDK](sdk/typescript.md)
 
 # Clients
@@ -39,15 +42,14 @@
   - [Prebuilt Binaries](clients/pre-built-binaries.md)
 - [Clients Overview](clients/overview.md)
 - [Websocket Client](clients/websocket-client.md)
-  - [Setup Guide](clients/websocket/guide.md)
-      - [Setup & Run](clients/websocket/setup.md)
-      - [Configuration](clients/websocket/config.md)
-      - [Using Your Client](clients/websocket/usage.md)
-      - [Examples](clients/websocket/examples.md)
-  - [Command Documentation](clients/websocket/commands.md)
+  - [Setup & Run](clients/websocket/setup.md)
+  - [Configuration](clients/websocket/config.md)
+  - [Using Your Client](clients/websocket/usage.md)
+  - [Examples](clients/websocket/examples.md)
+  - [Command Documentation (Autogenerated)](clients/websocket/nym-client-commands.md)
 - [Socks5 Client](clients/socks5-client.md)
   - [Setup Guide](clients/socks5/setup.md)
-  - [Command Documentation](clients/socks5/commands.md)
+  - [Command Documentation (Autogenerated)](clients/socks5/nym-socks5-client-commands)
 - [Webassembly Client](clients/webassembly-client.md)
 - [Addressing System](clients/addressing-system.md)
 
@@ -61,7 +63,8 @@
 
 # Tools
 - [NymCLI](tools/nym-cli.md)
-
+- [Command Documentation (Autogenerated)](tools/nym-cli/nym-cli-commands)
+
 # User Manuals
 - [NymVPN alpha](nymvpn/intro.md)
     - [CLI](nymvpn/cli.md)
@@ -80,6 +83,7 @@
 - [HCPP23-serinko](./events/hcpp23-serinko.md)
 - [HCPP23-max](./events/hcpp23-max.md)
 
+[//]: # (Maybe we can get rid of these?)
 # FAQ
 - [General](faq/general-faq.md)
 - [Integrations](faq/integrations-faq.md)

diff --git a/documentation/dev-portal/src/clients/client-binaries.md b/documentation/dev-portal/src/clients/client-binaries.md
@@ -1 +1,5 @@
 # Client Binaries
+
+The Nym codebase is written primarily in Rust. There are two methods to getting access to the different client and node binaries: 
+* [build them yourself](building-nym.md)
+* [download pre-compiled binaries from github](pre-built-binaries.md)
diff --git a/documentation/dev-portal/src/clients/socks5/commands.md b/documentation/dev-portal/src/clients/socks5/commands.md
@@ -1 +1 @@
-# Command Documentation
+# Command Documentation (Autogenerated)
diff --git a/documentation/dev-portal/src/clients/socks5/nym-socks5-client-commands b/documentation/dev-portal/src/clients/socks5/nym-socks5-client-commands
@@ -0,0 +1 @@
+# Command Documentation (Autogenerated)
diff --git a/...-portal/src/clients/websocket/commands.md → ...ents/socks5/nym-socks5-client-commands.md b/...-portal/src/clients/websocket/commands.md → ...ents/socks5/nym-socks5-client-commands.md
diff --git a/documentation/dev-portal/src/clients/socks5/setup.md b/documentation/dev-portal/src/clients/socks5/setup.md
@@ -19,6 +19,7 @@ You can check the necessary parameters for the available commands by running:
 ```
 ./nym-client <COMMAND> --help
 ```
+or check the autogenerated command documentation on the [next page](./nym-socks5-client-commands). 
 
 ### Initialising a new client instance
 Before you can use the client, you need to initalise a new instance of it, which can be done with the following command:
@@ -45,7 +46,7 @@ By default - as in the example above - your client will choose a random gateway
 However, there are several options for choosing a gateway, if you do not want one that is randomly assigned to your client:
 * If you wish to connect to a specific gateway, you can specify this with the `--gateway` flag when running `init`.
 * You can also choose a gateway based on its location relative to your client. This can be done by appending the `--latency-based-selection` flag to your `init` command. This command means that to select a gateway, your client will:
-    * fetch a list of all availiable gateways
+    * fetch a list of all available gateways
     * send few ping messages to all of them, and measure response times.
     * create a weighted distribution to randomly choose one, favouring ones with lower latency.
 

diff --git a/documentation/dev-portal/src/clients/websocket/nym-client-commands.md b/documentation/dev-portal/src/clients/websocket/nym-client-commands.md
@@ -0,0 +1 @@
+# Command Documentation (Autogenerated)
diff --git a/documentation/dev-portal/src/clients/websocket/setup.md b/documentation/dev-portal/src/clients/websocket/setup.md
@@ -25,6 +25,8 @@ You can check the necessary parameters for the available commands by running:
 ./nym-client <command> --help
 ```
 
+Or check the autogenerated command documentation on the [next page](./nym-client-commands.md).
+
 ## Initialising your client
 
 Before you can use the client, you need to initalise a new instance of it. Each instance of the client has its own public/private keypair, and connects to its own gateway node. Taken together, these 3 things (public/private keypair + gateway node identity key) make up an app's identity.

diff --git a/documentation/dev-portal/src/dev-overview.md b/documentation/dev-portal/src/dev-overview.md
@@ -0,0 +1 @@
+# Development Overview
diff --git a/documentation/dev-portal/src/sdk/rust/message-helpers.md b/documentation/dev-portal/src/sdk/rust/message-helpers.md
@@ -1,7 +1,7 @@
 # Message Helpers
 
 ## Handling incoming messages
-As seen in the [Chain querier tutorial](https://github.com/nymtech/developer-tutorials/blob/0130ee5a61cd6801bdcfc84608b2a520b5392714/rust/chain-query-service/) when listening out for a response to a sent message (e.g. if you have sent a request to a service, and are awaiting the response) you will want to await [non-empty messages (if you don't know why, read the info on this here)](troubleshooting.md#client-receives-empty-messages-when-listening-for-response). This can be done with something like the helper functions [here](https://github.com/nymtech/developer-tutorials/blob/0130ee5a61cd6801bdcfc84608b2a520b5392714/rust/chain-query-service/src/lib.rs#L71): 
+When listening out for a response to a sent message (e.g. if you have sent a request to a service, and are awaiting the response) you will want to await non-empty messages [(if you don't know why, read the info on this here)](troubleshooting.md#client-receives-empty-messages-when-listening-for-response). This can be done with something like the helper functions [here](https://github.com/nymtech/developer-tutorials/blob/0130ee5a61cd6801bdcfc84608b2a520b5392714/rust/chain-query-service/src/lib.rs#L71): 
 
 ```rust
 use nym_sdk::mixnet::ReconstructedMessage; 

diff --git a/documentation/dev-portal/src/tools/nym-cli.md b/documentation/dev-portal/src/tools/nym-cli.md
@@ -68,6 +68,8 @@ subcommands:
 ```
 ~~~
 
+Or check the autogenerated command documentation on the [next page](./nym-cli-commands.md).
+
 ## Example Usage
 Below we have listed some example commands for some of the features listed above.
 

diff --git a/documentation/dev-portal/src/tools/nym-cli/commands.md b/documentation/dev-portal/src/tools/nym-cli/commands.md
@@ -0,0 +1 @@
+# Command Documentation (Autogenerated)
diff --git a/documentation/dev-portal/src/tools/nym-cli/nym-cli-commands b/documentation/dev-portal/src/tools/nym-cli/nym-cli-commands
@@ -0,0 +1 @@
+# Command Documentation (Autogenerated)
diff --git a/documentation/dev-portal/src/tools/nym-cli/nym-cli-commands.md b/documentation/dev-portal/src/tools/nym-cli/nym-cli-commands.md
@@ -0,0 +1 @@
+# Command Documentation (Autogenerated)
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		# Command Documentation
		# Command Documentation (Autogenerated)
-Original file line number
+Diff line change
@@ Expand Up / @@ -68,6 +68,8 @@ subcommands: @@
     ```
     ~~~
+    Or check the autogenerated command documentation on the [next page](./nym-cli-commands.md).
     ## Example Usage
     Below we have listed some example commands for some of the features listed above.
@@ Expand Down @@