Max/dev portal update (#4696)

* updated tutorials with archive + stub

* removed out of date faq pages

* added binary build instructions section

* removed clients from docs

* added clients to devportal

* moved nym-vs-others to docs from devportal

* removed ood quickstart stuff

* tweaked integration options page

* summary changes for new structure

* moved sdk to devportal

* removed sdk from docs

* changed summary file for new structure

* added intro client overview page

* added wallet gif

* fixed now broken links

* removed old comm pages

* added references to newer apps (oreowallet + zcash demo)

* updated darkfi irc socks5

* fixed broken link

---------

Co-authored-by: mfahampshire <[email protected]>

Author: mfahampshire

documentation/dev-portal/src/SUMMARY.md

@@ -1,94 +1,59 @@
 #
-# Summary
-
 - [Introduction](introduction.md)
+- [Clients Overview - Start Here!](clients-overview.md)
+
+# SDKs 
+- [Rust SDK](sdk/rust/rust.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)
+
+# Binaries
+- [Pre-built Binaries](binaries/pre-built-binaries.md)
+- [Building from Source](binaries/building-nym.md)
+
+# Standalone Clients
+- [Websocket Client](clients/websocket-client.md)
+	- [Setup & Run](clients/websocket/setup.md)
+	- [Configuration](clients/websocket/config.md)
+	- [Using Your Client](clients/websocket/usage.md)
+	- [Examples](clients/websocket/examples.md)
+- [Socks5 Client](clients/socks5-client.md)
+  - [Setup & Run](clients/socks5/setup.md) 
+  - [Using Your Client](clients/socks5/usage.md)
+- [Webassembly Client](clients/webassembly-client.md)
 
-# Infrastructure
-
-- [What is Nym?](infrastructure/nym.md)
-- [Nym vs Other Systems](infrastructure/nym-vs-others.md)
-- [Node Types](infrastructure/node-types.md)
-
-# Quickstart
-
-- [Overview](quickstart/overview.md)
-- [Chat demo (webapp)](quickstart/chat-demo.md)
-- [Coconut Credential Playground (webapp)](quickstart/cred-playground.md)
-- [SOCKS Proxy (CLI)](quickstart/socks-proxy.md)
-
-# User Manuals
-
-- [NymVPN alpha](nymvpn/intro.md)
-    - [CLI](nymvpn/cli.md)
-
-<!-- OUTDATED STUFF:
-- [NymConnect X Monero](tutorials/monero.md)
-- [NymConnect X Matrix](tutorials/matrix.md)
-- [NymConnect X Telegram](tutorials/telegram.md)
-- [NymConnect X Electrum](tutorials/electrum.md)
-- [NymConnect X Firo wallet](tutorials/firo.md)
--->
+# Tutorials
+- [Stub: Updates Coming Soon!](./tutorials/coming-soon.md)
 
 # Code Examples
-
 - [Custom Service Providers](examples/custom-services.md)
 - [Apps Using Network Requesters](examples/using-nrs.md)
 - [Browser only](examples/browser-only.md)
 - [Monorepo examples](examples/monorepo-examples.md)
 
 # Integrations
-
 - [Integration Options](integrations/integration-options.md)
 [//]: # (- [Mixnet Integration]&#40;integrations/mixnet-integration.md&#41;)
 - [Payment Integration](integrations/payment-integration.md)
 
-# Tutorials
-
-- [Rust SDK](tutorials/rust-sdk.md)
-	- [Blockchain Service pt1](tutorials/cosmos-service/intro.md)
-		- [Tutorial Overview](tutorials/cosmos-service/overview.md)
-		- [Preparing Your Environment](tutorials/cosmos-service/preparing-env.md)
-		- [Preparing Your Lib](tutorials/cosmos-service/lib.md)
-		- [Preparing Your Client](tutorials/cosmos-service/client.md)
-		- [Preparing Your Client pt2](tutorials/cosmos-service/client-src.md)
-		- [Preparing Your Service](tutorials/cosmos-service/service.md)
-		- [Preparing Your Service pt2](tutorials/cosmos-service/service-src.md)
-		- [Querying the Chain](tutorials/cosmos-service/querying.md)
-
-- [Typescript](tutorials/typescript.md)
-    - [Simple Service Provider](tutorials/simple-service-provider/simple-service-provider.md)
-      	- [Tutorial Overview](tutorials/simple-service-provider/overview.md)
-      	- [Preparing Your User Client Environment](tutorials/simple-service-provider/preparating-env.md)
-      	- [Building Your User Client](tutorials/simple-service-provider/user-client.md)
-      	- [Preparing Your Service Provider Environment](tutorials/simple-service-provider/preparating-env2.md)
-      	- [Building Your Service Provider](tutorials/simple-service-provider/service-provider.md)
-      	- [Sending a Message Through the Mixnet](tutorials/simple-service-provider/sending-message.md)
-
-[//]: # (TODO make generic )
-[//]: # (# Shipyard Builders Hackathon 2023 )
-[//]: # (- [General Info & Resources]&#40;shipyard/general.md&#41;)
-[//]: # (- [Hackathon Challenges]&#40;shipyard/challenges-overview.md&#41;)
-[//]: # (- [A Note on Infrastructure]&#40;shipyard/infra.md&#41;)
-[//]: # (- [Submission Guidelines]&#40;shipyard/guidelines.md&#41;)
-
-<!-- Commenting out as a lot of the stuff is deprecated, can be purged as a part of the large overhaul
-# Events
-
-- [Web3Privacy Now](./events/web3-privacy.md)
-- [HCPP23-serinko](./events/hcpp23-serinko.md)
-- [HCPP23-max](./events/hcpp23-max.md)
--->
-
 # FAQ
-- [General](faq/general-faq.md)
 - [Integrations](faq/integrations-faq.md)
-- [Rewards & Token](faq/rewards-faq.md)
-
-# Community Resources
 
-- [Nym DevRel AMAs](community-resources/ama.md)
-- [Community Applications and Guides](community-resources/community-applications-and-guides.md)
-- [Change Service Grantee Information](info-request.md)
+# User Manuals
+- [NymVPN alpha](nymvpn/intro.md)
+    - [CLI](nymvpn/cli.md)
 
 ---
 # Misc.

documentation/dev-portal/src/binaries/building-nym.md

@@ -0,0 +1,61 @@
+# Building from Source
+
+> Nym runs on Mac OS X, Linux, and Windows. All nodes **except the Desktop Wallet and NymConnect** on Windows should be considered experimental - it works fine if you're an app developer but isn't recommended for running nodes.
+
+## Building Nym
+Nym has two main codebases:
+
+- the [Nym platform](https://github.com/nymtech/nym), written in Rust. This contains all of our code _except_ for the validators.
+- the [Nym validators](https://github.com/nymtech/nyxd), written in Go.
+
+> This page details how to build the main Nym platform code.
+
+## Prerequisites
+- Debian/Ubuntu: `pkg-config`, `build-essential`, `libssl-dev`, `curl`, `jq`, `git`
+
+```
+apt install pkg-config build-essential libssl-dev curl jq git
+```
+
+- Arch/Manjaro: `base-devel`
+
+```
+pacman -S base-devel
+```
+
+- Mac OS X: `pkg-config` , `brew`, `openss1`, `protobuf`, `curl`, `git`
+Running the following the script installs Homebrew and the above dependencies:
+
+```
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+```
+
+- `Rust & cargo >= {{minimum_rust_version}}`
+
+We recommend using the [Rust shell script installer](https://www.rust-lang.org/tools/install). Installing cargo from your package manager (e.g. `apt`) is not recommended as the packaged versions are usually too old.
+
+If you really don't want to use the shell script installer, the [Rust installation docs](https://forge.rust-lang.org/infra/other-installation-methods.html) contain instructions for many platforms.
+
+## Download and build Nym binaries
+The following commands will compile binaries into the `nym/target/release` directory:
+
+```sh
+rustup update
+git clone https://github.com/nymtech/nym.git
+cd nym
+
+git reset --hard # in case you made any changes on your branch
+git pull # in case you've checked it out before
+
+git checkout master # master branch has the latest release version: `develop` will most likely be incompatible with deployed public networks
+
+cargo build --release # build your binaries with **mainnet** configuration
+```
+
+Quite a bit of stuff gets built. The key working parts for devs are the Client binaries and the CLI tool: 
+
+* [websocket client](../clients/websocket-client.md): `nym-client`
+* [socks5 client](../clients/socks5-client.md): `nym-socks5-client`
+* [nym-cli tool](https://nymtech.net/docs/tools/nym-cli.md): `nym-cli`
+
+> You cannot build from GitHub's .zip or .tar.gz archive files on the releases page - the Nym build scripts automatically include the current git commit hash in the built binary during compilation, so the build will fail if you use the archive code (which isn't a Git repository). Check the code out from github using `git clone` instead.

documentation/dev-portal/src/binaries/pre-built-binaries.md

@@ -0,0 +1,6 @@
+# Pre-built Binaries
+
+The [Github releases page](https://github.com/nymtech/nym/releases) has pre-built binaries which should work on Ubuntu 20.04 and other Debian-based systems, but at this stage cannot be guaranteed to work everywhere.
+
+If the pre-built binaries don't work or are unavailable for your system, you will need to build the platform yourself.
+

documentation/dev-portal/src/clients-overview.md

@@ -0,0 +1,49 @@
+# Clients Overview 
+
+A large proportion of the Nym mixnet's functionality is implemented client-side. 
+
+Clients perform the following actions on behalf of users: 
+
+* determine network topology - what mixnodes exist, what their keys are, etc.
+* register with a gateway
+* authenticate with a gateway
+* receive and decrypt messages from the gateway
+* create layer-encrypted Sphinx packets
+* send Sphinx packets with real messages
+* send Sphinx packet _cover traffic_ when no real messages are being sent
+* retransmit un-acknowledged packet sends - if a client sends 100 packets to a gateway, but only receives an acknowledgement ('ack') for 95 of them, it will resend those 5 packets to the gateway again, to make sure that all packets are received.  
+
+> As a developer, you'll want to use a Nym client to send your application network traffic through the mixnet; whether that is an RPC call, a TCP connection request, or treating it like a UDP pipe, you need to send whatever bytes your app needs to send through it. However, unlike (e.g.) a TCP Socket, Nym client communication is message-based, so you cannot (yet) simply plug-and-play using the mixnet as a seamless drop-in replacement. We are currently working on stream-like abstractions for ease of integration with the Rust SDK. 
+
+## Types of Nym clients
+At present, there are three Nym clients:
+
+- the websocket (native) client
+- the SOCKS5 client
+- the wasm (webassembly) client
+
+You need to choose which one you want incorporate into your app. Which one you use will depend largely on your preferred programming style and the purpose of your app.
+
+### The websocket client
+Your first option is the native websocket client (`nym-client`). This is a compiled program that can run on Linux, Mac OS X, and Windows machines. It can be run as a persistent process on a desktop or server machine. You can connect to it with **any language that supports websockets**. 
+
+> Rust developers can import websocket client functionality into their code via the [Rust SDK](sdk/rust/rust.md). 
+
+### The webassembly client
+If you're working in JavaScript or Typescript in the browser, or building an [edge computing](https://en.wikipedia.org/wiki/Edge_computing) app, you'll likely want to choose the webassembly client. 
+
+It's packaged and [available on the npm registry](https://www.npmjs.com/package/@nymproject/nym-client-wasm), so you can `npm install` it into your JavaScript or TypeScript application. 
+
+> The webassembly client is most easily used via the [Typescript SDK](sdk/typescript.md). Typescript developers who wish to send API requests through the mixnet can can also check the [`mixfetch`]() package.
+
+### The SOCKS5 client
+The `nym-socks5-client` is useful for allowing existing applications to use the Nym mixnet without any code changes. All that's necessary is that they can use one of the SOCKS5, SOCKS4a, or SOCKS4 proxy protocols (which many applications can - crypto wallets, browsers, chat applications etc). 
+
+When used as a standalone client, it's less flexible as a way of writing custom applications than the other clients, but able to be used to proxy application traffic through the mixnet without having to make any code changes. 
+
+> Rust developers can import socks client functionality into their code via the [Rust SDK](sdk/rust/rust.md). 
+
+## Commonalities between clients
+All Nym client packages present basically the same capabilities to the privacy application developer. They need to run as a persistent process in order to stay connected and ready to receive any incoming messages from their gateway nodes. They register and authenticate to gateways, and encrypt Sphinx packets.
+
+

documentation/docs/src/clients/overview.md renamed to documentation/dev-portal/src/clients/overview.md

@@ -25,14 +25,14 @@ You need to choose which one you want incorporate into your app. Which one you u
 ### The websocket client
 Your first option is the native websocket client (`nym-client`). This is a compiled program that can run on Linux, Mac OS X, and Windows machines. It can be run as a persistent process on a desktop or server machine. You can connect to it with **any language that supports websockets**. 
 
-_Rust developers can import websocket client functionality into their code via the [Rust SDK](../sdk/rust/rust.md)_. 
+> Rust developers can import websocket client functionality into their code via the [Rust SDK](../sdk/rust/rust.md). 
 
 ### The webassembly client
 If you're working in JavaScript or Typescript in the browser, or building an [edge computing](https://en.wikipedia.org/wiki/Edge_computing) app, you'll likely want to choose the webassembly client. 
 
 It's packaged and [available on the npm registry](https://www.npmjs.com/package/@nymproject/nym-client-wasm), so you can `npm install` it into your JavaScript or TypeScript application. 
 
-_The webassembly client is most easily used via the [Typescript SDK](../sdk/typescript.md)_. 
+> The webassembly client is most easily used via the [Typescript SDK](../sdk/typescript.md). Typescript developers who wish to send API requests through the mixnet can can also check the [`mixfetch`]() package.
 
 ### The SOCKS5 client
 The `nym-socks5-client` is useful for allowing existing applications to use the Nym mixnet without any code changes. All that's necessary is that they can use one of the SOCKS5, SOCKS4a, or SOCKS4 proxy protocols (which many applications can - crypto wallets, browsers, chat applications etc). 

documentation/docs/src/clients/socks5-client.md renamed to documentation/dev-portal/src/clients/socks5-client.md

@@ -1,6 +1,6 @@
 # Socks5 Client
 
-> The Nym socks5 client was built in the [building nym](../binaries/building-nym.md) section. If you haven't yet built Nym and want to run the code on this page, go there first.
+> The Nym Socks5 Client was built in the [building nym](../binaries/building-nym.md) section. If you haven't yet built Nym and want to run the code on this page, go there first.
 
 ## Current version
 ```
@@ -60,7 +60,7 @@ There are 2 pieces of software that work together to send SOCKS traffic through
 The `nym-socks5-client` allows you to do the following from your local machine:
 * Take a TCP data stream from a application that can send traffic via SOCKS5.
 * Chop up the TCP stream into multiple Sphinx packets, assigning sequence numbers to them, while leaving the TCP connection open for more data
-* Send the Sphinx packets through the mixnet to a [network requester](../nodes/network-requester.md). Packets are shuffled and mixed as they transit the mixnet.
+* Send the Sphinx packets through the mixnet to a [network requester](https://nymtech.net/operators/nodes/network-requester.md). Packets are shuffled and mixed as they transit the mixnet.
 
 The `nym-network-requester` then reassembles the original TCP stream using the packets' sequence numbers, and make the intended request. It will then chop up the response into Sphinx packets and send them back through the mixnet to your  `nym-socks5-client`. The application will then receive its data, without even noticing that it wasn't talking to a "normal" SOCKS5 proxy!
 
@@ -100,11 +100,11 @@ Before you can use the client, you need to initalise a new instance of it, which
 
 The `--id` in the example above is a local identifier so that you can name your clients and keep track of them on your local system; it is **never** transmitted over the network.
 
-The `--use-reply-surbs` field denotes whether you wish to send [SURBs](../architecture/traffic-flow.md#private-replies-using-surbs) along with your request. It defaults to `false`, we are explicitly setting it as `true`. It defaults to `false` for compatibility with older versions of the [Network Requester](../nodes/network-requester.md).
+The `--use-reply-surbs` field denotes whether you wish to send [SURBs](https://nymtech.net/docs/architecture/traffic-flow.md#private-replies-using-surbs) along with your request. It defaults to `false`, we are explicitly setting it as `true`. It defaults to `false` for compatibility with older versions of the [Network Requester](https://nymtech.net/nodes/network-requester.md).
 
-The `--provider` field needs to be filled with the Nym address of a Network Requester that can make network requests on your behalf. If you don't want to [run your own](../nodes/network-requester.md) you can select one from the [mixnet explorer](https://explorer.nymtech.net/network-components/service-providers) by copying its `Client ID` and using this as the value of the `--provider` flag. Alternatively, you could use [this list](https://harbourmaster.nymtech.net/).
+The `--provider` field needs to be filled with the Nym address of a Network Requester that can make network requests on your behalf. If you don't want to [run your own](https://nymtech.net/operators/nodes/network-requester.md) you can select one from the [mixnet explorer](https://explorer.nymtech.net/network-components/service-providers) by copying its `Client ID` and using this as the value of the `--provider` flag. Alternatively, you could use [this list](https://harbourmaster.nymtech.net/).
 
-Since the nodes on this list are the infrastructure for [Nymconnect](https://nymtech.net/developers/quickstart/nymconnect-gui.html) they will support all apps on the [default whitelist](../nodes/network-requester.md#network-requester-whitelist): Keybase, Telegram, Electrum, Blockstream Green, and Helios.
+Since the nodes on this list are the infrastructure for [Nymconnect](https://nymtech.net/developers/quickstart/nymconnect-gui.html) they will support all apps on the [default whitelist](https://nymtech.net/operators/nodes/network-requester.md#network-requester-whitelist): Keybase, Telegram, Electrum, Blockstream Green, and Helios.
 
 #### Choosing a Gateway
 By default - as in the example above - your client will choose a random gateway to connect to.

documentation/dev-portal/src/quickstart/socks-proxy.md renamed to documentation/dev-portal/src/clients/socks5/setup.md

@@ -1,4 +1,4 @@
-# SOCKS Proxy (CLI)
+# Setup 
 
 > `nym-socks5-client` now also supports SOCKS4 and SOCKS4A protocols as well as SOCKS5.
 
@@ -39,33 +39,4 @@ Now your client is initialised, start it with the following:
 ./nym-socks5-client run --id <ID>
 ```
 
-## Proxying traffic
-After completing the steps above, your local `nym-socks5-client` will be listening on `localhost:1080` ready to proxy traffic to the Network Requester set as the `--provider` when initialising.
 
-When trying to connect your app, generally the proxy settings are found in `settings->advanced` or `settings->connection`.
-
-Here is an example of setting the proxy connecting in Blockstream Green:
-
-![Blockstream Green settings](../images/blockstream-green.gif)
-
-Most wallets and other applications will work basically the same way: find the network proxy settings, enter the proxy url (host: **localhost**, port: **1080**).
-
-In some other applications, this might be written as **localhost:1080** if there's only one proxy entry field.
-
-## Supported Applications
-
-Any application which can be redirected over Socks5 proxy should work. Nym community has been successfully running over Nym Mixnet these applications:
-
-- Bitcoin Electrum wallet
-- Monero wallet (GUI and CLI with monerod)
-- Telegram chat
-- Element/Matrix chat
-- Firo wallet
-- ircd chat
-- Blockstream Green
-
-Keep in mind that Nym has been developing a new client **[NymVPN](https://nymvpn.com) (GUI and CLI) routing all users traffic through the Mixnet.**
-
-## Further reading
-
-If you want to dig more into the architecture and use of the socks5 client check out its documentation [here](https://nymtech.net/docs/clients/socks5-client.html).