From e59ef014004c7b83cafde3f98630d1e66d5b8342 Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Tue, 14 May 2024 16:29:35 +0200 Subject: [PATCH] more reorg and dead links --- documentation/dev-portal/src/SUMMARY.md | 50 ++++++++++--------- .../dev-portal/src/clients/client-binaries.md | 4 ++ .../dev-portal/src/clients/socks5/commands.md | 2 +- .../clients/socks5/nym-socks5-client-commands | 1 + .../nym-socks5-client-commands.md} | 0 .../dev-portal/src/clients/socks5/setup.md | 3 +- .../clients/websocket/nym-client-commands.md | 1 + .../dev-portal/src/clients/websocket/setup.md | 2 + documentation/dev-portal/src/dev-overview.md | 1 + .../src/sdk/rust/message-helpers.md | 2 +- documentation/dev-portal/src/tools/nym-cli.md | 2 + .../dev-portal/src/tools/nym-cli/commands.md | 1 + .../src/tools/nym-cli/nym-cli-commands | 1 + .../src/tools/nym-cli/nym-cli-commands.md | 1 + 14 files changed, 45 insertions(+), 26 deletions(-) create mode 100644 documentation/dev-portal/src/clients/socks5/nym-socks5-client-commands rename documentation/dev-portal/src/clients/{websocket/commands.md => socks5/nym-socks5-client-commands.md} (100%) create mode 100644 documentation/dev-portal/src/clients/websocket/nym-client-commands.md create mode 100644 documentation/dev-portal/src/dev-overview.md create mode 100644 documentation/dev-portal/src/tools/nym-cli/commands.md create mode 100644 documentation/dev-portal/src/tools/nym-cli/nym-cli-commands create mode 100644 documentation/dev-portal/src/tools/nym-cli/nym-cli-commands.md diff --git a/documentation/dev-portal/src/SUMMARY.md b/documentation/dev-portal/src/SUMMARY.md index cb15bfb1e59..14d6ae62bfa 100644 --- a/documentation/dev-portal/src/SUMMARY.md +++ b/documentation/dev-portal/src/SUMMARY.md @@ -1,8 +1,11 @@ [//]: # (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) [//]: # () @@ -10,7 +13,7 @@ [//]: # (- [Nym vs Other Systems](infrastructure/nym-vs-others.md)) [//]: # (- [Node Types](infrastructure/node-types.md)) -[//]: # (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) @@ -18,19 +21,19 @@ # 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 index 3a78cba6f32..80cc182b505 100644 --- 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) \ No newline at end of file diff --git a/documentation/dev-portal/src/clients/socks5/commands.md b/documentation/dev-portal/src/clients/socks5/commands.md index f543a93583d..76f6ef39c7c 100644 --- 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 new file mode 100644 index 00000000000..76f6ef39c7c --- /dev/null +++ b/documentation/dev-portal/src/clients/socks5/nym-socks5-client-commands @@ -0,0 +1 @@ +# Command Documentation (Autogenerated) diff --git a/documentation/dev-portal/src/clients/websocket/commands.md b/documentation/dev-portal/src/clients/socks5/nym-socks5-client-commands.md similarity index 100% rename from documentation/dev-portal/src/clients/websocket/commands.md rename to documentation/dev-portal/src/clients/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 index 0e6156b4ddc..c50053bb0af 100644 --- 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 --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 new file mode 100644 index 00000000000..76f6ef39c7c --- /dev/null +++ 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 index e682e87175b..f2e036cc555 100644 --- 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 --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 new file mode 100644 index 00000000000..7c981e3406c --- /dev/null +++ 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 index e7ce201fa73..c4988d476ba 100644 --- 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 index f218e9fa44a..dad361d2daf 100644 --- 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 new file mode 100644 index 00000000000..76f6ef39c7c --- /dev/null +++ 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 new file mode 100644 index 00000000000..76f6ef39c7c --- /dev/null +++ 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 new file mode 100644 index 00000000000..76f6ef39c7c --- /dev/null +++ b/documentation/dev-portal/src/tools/nym-cli/nym-cli-commands.md @@ -0,0 +1 @@ +# Command Documentation (Autogenerated)