operators/maintenance page: syntax corrections

Release/v1.1.30 twix

.github/workflows/cd-docs.yml

@@ -38,6 +38,7 @@ jobs:
       - name: Build all projects in documentation/ & move to ~/dist/docs/
         run: cd documentation && ./build_all_to_dist.sh
         continue-on-error: false
+
       - name: Deploy branch master to dev
         continue-on-error: true
         uses: easingthemes/ssh-deploy@main
@@ -49,6 +50,7 @@ jobs:
           REMOTE_USER: ${{ secrets.CD_WWW_REMOTE_USER }}
           TARGET: ${{ secrets.CD_WWW_REMOTE_TARGET }}/
           EXCLUDE: "/node_modules/"
+
       - name: Deploy branch master to prod
         if: github.ref == 'refs/heads/master'
         uses: easingthemes/ssh-deploy@main
@@ -60,6 +62,49 @@ jobs:
           REMOTE_USER: ${{ secrets.CD_WWW_REMOTE_USER }}
           TARGET: ${{ secrets.CD_WWW_REMOTE_TARGET }}/
           EXCLUDE: "/node_modules/"
+
+      - name: Post process
+        run: cd documentation && ./post_process.sh
+        continue-on-error: false
+
+      - name: Create Vercel project file
+        uses: mobiledevops/secret-to-file-action@v1
+        with:
+          base64-encoded-secret: ${{ secrets.VERCEL_PROJECT_JSON_BASE64 }}
+          filename: "project.json"
+          is-executable: true
+          working-directory: "./dist/docs/.vercel"
+
+      - name: Install Vercel CLI
+        run: npm install --global vercel@latest
+
+      - name: Pull Vercel Environment Information (preview)
+        if: github.ref != 'refs/heads/master'
+        run: vercel pull --yes --environment=preview --token=${{ secrets.VERCEL_TOKEN }}
+        working-directory: dist/docs
+      - name: Pull Vercel Environment Information (production)
+        if: github.ref == 'refs/heads/master'
+        run: vercel pull --yes --environment=production --token=${{ secrets.VERCEL_TOKEN }}
+        working-directory: dist/docs
+
+      - name: Build Project Artifacts (preview)
+        if: github.ref != 'refs/heads/master'
+        run: vercel build --token=${{ secrets.VERCEL_TOKEN }}
+        working-directory: dist/docs
+      - name: Build Project Artifacts (production)
+        if: github.ref == 'refs/heads/master'
+        run: vercel build --prod --token=${{ secrets.VERCEL_TOKEN }}
+        working-directory: dist/docs
+
+      - name: Deploy Project Artifacts to Vercel (preview)
+        if: github.ref != 'refs/heads/master'
+        run: vercel deploy --prebuilt --token=${{ secrets.VERCEL_TOKEN }}
+        working-directory: dist/docs
+      - name: Deploy Project Artifacts to Vercel (master)
+        if: github.ref == 'refs/heads/master'
+        run: vercel deploy --prebuilt --prod --token=${{ secrets.VERCEL_TOKEN }}
+        working-directory: dist/docs
+
       - name: Matrix - Node Install
         run: npm install
         working-directory: .github/workflows/support-files

CHANGELOG.md

@@ -4,6 +4,20 @@ Post 1.0.0 release, the changelog format is based on [Keep a Changelog](https://
 
 ## [Unreleased]
 
+## [v1.1.30-twix] (2023-09-05)
+
+- geo_aware_provider: fix too much filtering of gateways ([#3826])
+- network-requester: add description to config ([#3799])
+- Speedy mode - selects gateway based on latency  in medium / speedy mode ([#3770])
+- Chore/enable versioning ([#3768])
+- Create explorer-client and use in geo aware provider ([#3824])
+
+[#3826]: https://github.com/nymtech/nym/pull/3826
+[#3799]: https://github.com/nymtech/nym/pull/3799
+[#3770]: https://github.com/nymtech/nym/issues/3770
+[#3768]: https://github.com/nymtech/nym/pull/3768
+[#3824]: https://github.com/nymtech/nym/pull/3824
+
 ## [v1.1.29-snickers] (2023-08-29)
 
 - Add EXPLORER_API configurable url ([#3810])

Cargo.lock

@@ -2768,7 +2768,7 @@ checksum = "0206175f82b8d6bf6652ff7d71a1e27fd2e4efde587fd368662814d6ec1d9ce0"
 
 [[package]]
 name = "explorer-api"
-version = "1.1.27"
+version = "1.1.28"
 dependencies = [
  "chrono",
  "clap 4.3.21",
@@ -5638,7 +5638,7 @@ dependencies = [
 
 [[package]]
 name = "nym-api"
-version = "1.1.28"
+version = "1.1.29"
 dependencies = [
  "actix-web",
  "anyhow",
@@ -5785,7 +5785,7 @@ dependencies = [
 
 [[package]]
 name = "nym-cli"
-version = "1.1.27"
+version = "1.1.28"
 dependencies = [
  "anyhow",
  "base64 0.13.1",
@@ -5858,7 +5858,7 @@ dependencies = [
 
 [[package]]
 name = "nym-client"
-version = "1.1.27"
+version = "1.1.28"
 dependencies = [
  "clap 4.3.21",
  "dirs 4.0.0",
@@ -6166,7 +6166,7 @@ dependencies = [
 
 [[package]]
 name = "nym-gateway"
-version = "1.1.27"
+version = "1.1.28"
 dependencies = [
  "anyhow",
  "async-trait",
@@ -6321,7 +6321,7 @@ dependencies = [
 
 [[package]]
 name = "nym-mixnode"
-version = "1.1.28"
+version = "1.1.29"
 dependencies = [
  "anyhow",
  "bs58 0.4.0",
@@ -6439,7 +6439,7 @@ dependencies = [
 
 [[package]]
 name = "nym-network-requester"
-version = "1.1.27"
+version = "1.1.28"
 dependencies = [
  "anyhow",
  "async-file-watcher",
@@ -6486,7 +6486,7 @@ dependencies = [
 
 [[package]]
 name = "nym-network-statistics"
-version = "1.1.27"
+version = "1.1.28"
 dependencies = [
  "dirs 4.0.0",
  "log",
@@ -6651,7 +6651,7 @@ dependencies = [
 
 [[package]]
 name = "nym-socks5-client"
-version = "1.1.27"
+version = "1.1.28"
 dependencies = [
  "clap 4.3.21",
  "lazy_static",

clients/native/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nym-client"
-version = "1.1.27"
+version = "1.1.28"
 authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>", "Jędrzej Stuczyński <andrew@nymtech.net>"]
 description = "Implementation of the Nym Client"
 edition = "2021"

clients/socks5/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nym-socks5-client"
-version = "1.1.27"
+version = "1.1.28"
 authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>"]
 description = "A SOCKS5 localhost proxy that converts incoming messages to Sphinx and sends them to a Nym address"
 edition = "2021"

documentation/README.md

@@ -7,7 +7,7 @@ Each directory contains a readme with more information about running and contrib
 * `operators` contains node setup and maintenance guides hosted at [https://nymtech.net/operators](https://nymtech.net/operators)
 
 ## Scripts 
-* `bump_versions.sh` allows you to update the `platform_release_version` and `wallet_release_version` variables in the `book.toml` of each mdbook project at once. You can also optionally update the `minimum_rust_version` as well. Helpful for lazy-updating when cutting a new version of the docs. 
-  * `build_all_to_dist.sh` is used by the `ci-dev.yml` and `cd-dev.yml` scripts for building all mdbook projects and moving the rendered html to `../dist/` to be rsynced with various servers. 
+* `bump_versions.sh` allows you to update the ~~`platform_release_version` and~~ `wallet_release_version` variable~~s~~ in the `book.toml` of each mdbook project at once. You can also optionally update the `minimum_rust_version` as well. Helpful for lazy-updating when cutting a new version of the docs. 
+* `build_all_to_dist.sh` is used by the `ci-dev.yml` and `cd-dev.yml` scripts for building all mdbook projects and moving the rendered html to `../dist/` to be rsynced with various servers. 
 
 

documentation/bump_versions.sh

@@ -1,21 +1,21 @@
 #!/usr/bin/env bash
-# this takes two args: platform release version and wallet release version.
+# takes one manadatory arg and one optional arg: wallet release and minimum rust versions
 # it then uses sed to bump them in the three book.toml files.
 #
-# e.g if the upcoming platform release was v1.1.29 and the release version 1.2.9 you'd run this as:
-# `./bump_versions.sh "1.1.29" "1.2.9"`
+# e.g if the upcoming wallet release version was 1.2.9 you'd run this as:
+# `./bump_versions.sh "1.2.9"`
 #
-# you can also set the minumum rust version by passing an optional 3rd argument:
-# `./bump_versions.sh "1.1.29" "1.2.9" "1.67"`
+# you can also set the minumum rust version by passing an optional additional argument:
+# `./bump_versions.sh "1.2.9" "1.67"`
 
 # array of project dirs
 declare -a projects=("docs" "dev-portal" "operators")
 
 # check number of args passed
-if [ "$#" -lt 2 ] || [ "$#" -gt 3 ];
+if [ "$#" -lt 1 ] || [ "$#" -gt 2 ];
 then
-    echo "failure: please pass at least 2 and at most 3 args: "
-    echo "./bump_version.sh <new platform_release_version> <new wallet_release_version> [OPTIONAL]<new minimum_rust_version>"
+    echo "failure: please pass at least 1 and at most 2 args: "
+    echo "./bump_version.sh <new wallet_release_version> [OPTIONAL]<new minimum_rust_version>"
     exit 0
 fi
 
@@ -29,8 +29,7 @@ else
   for i in "${projects[@]}"
   do
     # sed the vars in the book.toml file for each project
-    echo "setting platform and wallet versions in $i/"
-    sed -i 's/platform_release_version =.*/platform_release_version = "'$1'"/' "$i"/book.toml
+    echo "setting wallet version in $i/"
     sed -i 's/wallet_release_version =.*/wallet_release_version = "'$2'"/' "$i"/book.toml
     if [ "$3" ]
     then

documentation/dev-portal/README.md

@@ -12,7 +12,7 @@ If you have built a project with Nym or are compiling and writing resources abou
 ## Variables
 There are some variables that are shared across this book, such as the current latest software version.
 
-Variables are denoted in the `.md` files wrapped in `{{}}` (e.g `{{platform_release_version}}` is the most recent release), and are located in the `book.toml` file under the `[preprocessor.variables.variables]` heading. If you are changing something like the software release version, minimum code versions in prerequisites, etc, **check in here first!**
+Variables are denoted in the `.md` files wrapped in `{{}}` (e.g `{{wallet_release_version}}`), and are located in the `book.toml` file under the `[preprocessor.variables.variables]` heading. If you are changing something like the software release version, minimum code versions in prerequisites, etc, **check in here first!**
 
 ## Building
 When working locally, it is recommended that you use `mdbook serve` to have a local version of the docs served on `localhost:3000`, with hot reloading on any changes made to files in the `src/` directory.

documentation/dev-portal/book.toml

@@ -38,7 +38,7 @@ chapter-line-height       = "2em"
 section-line-height       = "1.5em"
 
 # if true, never read and touch the files in theme dir
-turn-off = false
+turn-off = true
 
 
 [preprocessor.admonish]
@@ -49,7 +49,6 @@ assets_version = "2.0.0" # do not edit: managed by `mdbook-admonish install`
 # https://gitlab.com/tglman/mdbook-variables/
 [preprocessor.variables.variables]
 minimum_rust_version = "1.66"
-platform_release_version = "1.1.29"
 wallet_release_version = "1.2.8"
 
 [preprocessor.last-changed]

documentation/dev-portal/src/integrations/faq.md

@@ -110,7 +110,7 @@ Yes, it is supported.
 Yes. Follow the instructions in the [Ledger support for Nyx documentation](https://nymtech.net/docs/nyx/ledger-live.html). 
 
 ### Where can I find network details such as deployed smart contract addresses? 
-In the [`network defaults`](https://github.com/nymtech/nym/blob/release/{{platform_release_version}}/common/network-defaults/src/mainnet.rs) file. 
+In the [`network defaults`](https://github.com/nymtech/nym/blob/master/common/network-defaults/src/mainnet.rs) file. 
 
 ## `NYM` Token 
 The token used to reward mixnet infrastructure operators - `NYM` - is one of the native tokens of the Nyx blockchain. The other token is `NYX`. 
@@ -198,4 +198,4 @@ For the moment then yes, the mixnet is free to use. There are no limits on the a
 No, although we do recommend that apps that wish to integrate look into running some of their own infrastructure such as gateways in order to assure uptime. 
 
 ### How can I find out if an application is already supported by network requester services? 
-You can check the [default allowed list](https://nymtech.net/.wellknown/network-requester/standard-allowed-list.txt) file to see which application traffic is whitelisted by default. If the domain is present on that list, it means that existing [network requesters](https://nymtech.net/docs/nodes/network-requester-setup.html) can be used to privacy-protect your application traffic. Simply use [NymConnect](../quickstart/nymconnect-gui.md) to connect to this service through the mixnet.  
+You can check the [default allowed list](https://nymtech.net/.wellknown/network-requester/standard-allowed-list.txt) file to see which application traffic is whitelisted by default. If the domain is present on that list, it means that existing [network requesters](https://nymtech.net/docs/nodes/network-requester-setup.html) can be used to privacy-protect your application traffic. Simply use [NymConnect](../quickstart/nymconnect-gui.md) to connect to this service through the mixnet.  

documentation/dev-portal/src/integrations/mixnet-integration.md

@@ -22,7 +22,7 @@ It’s packaged and available on the npm registry, so you can npm install it int
 
 The webassembly client is most easily used via the [typescript sdk](https://nymtech.net/docs/sdk/typescript.html).
 
-You can find example code in the [examples section](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/sdk/typescript/examples) of the codebase, and in the [typescript sdk docs](https://nymtech.net/docs/sdk/typescript.html).
+You can find example code in the [examples section](https://github.com/nymtech/nym/tree/master/sdk/typescript/examples) of the codebase, and in the [typescript sdk docs](https://nymtech.net/docs/sdk/typescript.html).
 
 #### SOCKS client
 This 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/dev-portal/src/quickstart/nymconnect-gui.md

@@ -11,7 +11,7 @@ Install NymConnect and select an application that you want to privacy-enhance fr
 **Please note that NymConnect is currently released in beta. Please report bugs via Github**. 
 
 ## Usage instuctions 
-* [Download](https://github.com/nymtech/nym/releases/tag/nym-connect-{{platform_release_version}}) and install NymConnect.
+* [Download](https://github.com/nymtech/nym/releases/) and install NymConnect.
 * Select your service provider from the dropdown menu.
 * Click `connect` - NymConnect will connect to a service provider and its SOCKS Proxy (IP) and Port will be displayed.
 * Click on IP or Port to copy their values to the clipboard.

documentation/dev-portal/src/tutorials/matrix.md

@@ -1,5 +1,6 @@
 # Matrix NymConnect Integration
 
+![](../images//matrix.png)
 
 Chat applications became an essential part of human communication. Matrix chat has end to end encryption on protocol level and Element app users can sort their communication into spaces and rooms. Now the Matrix communities can rely on network privacy as NymConnect supports Matrix chat protocol.
 

documentation/dev-portal/src/tutorials/monero.md

@@ -10,33 +10,35 @@ A team made up of Monero community members have successfully set up a service pr
 
 ## How can I use Monero over the Nym mixnet?
 
+> Any syntax in `<>` brackets is a user's unique variable. Exchange with a corresponding name without the `<>` brackets.
+
 The mainnet service provider to Monero over the Nym mixnet is now ready for use via [NymConnect](https://nymtech.net/download-nymconnect/).
 
-* Download and open the latest version of [NymConnect](https://nymtech.net/download-nymconnect/).
-* Click on the top left options and go to Settings
-* Go to “Select service provider” and turn it on
-* For Mainnet, search for this provider or insert it manually:
-
+* **Download** the latest version of [**NymConnect**](https://nymtech.net/download-nymconnect/).
+* Make sure your NymConnect is executable.
 ```sh
-i1TiuoNp4jp9weffCW7tPnkb4hRTPydRjX8iXFVaYDG.88Z1hruuvbzWpdCE2xYnTbPNrr49j4s7mmUQC5wvRRLZ@3EPuxwGn2WP2HdxybzoDa5QsohYSP76aQQRUJuPMvk23
+# in Linux open terminal in the same folder and run:
+chmod +x ./nym-connect_<YOUR_VERSION>.AppImage
 ```
+* **Open NymConnect app**
+* **Turn it on** - Monero wallet is listed in the apps supported by default, no need for any setup
+* **Copy** the **Socks5 address** and **Port**
 
-* Go to the main NymConnect interface and connect to the mixnet
+Then go to your Monero wallet (desktop or CLI) and change the settings to run over socks5 proxy:
 
-Then go to your Monero wallet (gui or otherwise) and change the settings to run over socks5 proxy:
+**Monero desktop wallet:**
 
-**Monero desktop:**
-
-* Settings -> Interface -> Socks5 proxy -> Add values: IP address `localhost`, Port `1080`
+* Settings -> Interface -> Socks5 proxy -> Add values: IP address `127.0.0.1`, Port `1080` (the values copied from NymConnect)
 
+<!---commenting the video as it has a redundant part about manual NR setup
 <iframe width="700" height="400" src="https://www.youtube.com/embed/oSHnk1BG_f0" title="Demo: Connect Your Monero Wallet to the Nym Mixnet via NymConnect" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
-
-**CLI**
+--->
+**CLI wallet**
 
 * **Monerod:** add `--proxy 127.0.0.1:1080 --bootstrap-daemon-proxy 127.0.0.1:1080` to args
 
 * **Monero-wallet-{rpc, cli}:** add `--proxy 127.0.0.1:1080 --daemon-ssl-allow-any-cert` to args
 
-Follow the instructions and the Monero mainnet will be connected through to the Nym mixnet.
-
 For those who want to try it out in testnet, a stagenet service provider is also available: [https://nymtech.net/.wellknown/connect/service-providers.json](https://nymtech.net/.wellknown/connect/service-providers.json)
+
+Now your Monero traffic is protected by the network privacy of Nym Mixnet. 

documentation/dev-portal/src/tutorials/telegram.md

@@ -2,6 +2,8 @@
 
 *This is a shortened version of a [Nym Community post](https://blog.nymtech.net/how-to-use-telegram-in-iraq-with-nymconnect-106a3b8dd050) written by Saliveja.*
 
+![](../images/telegram.png)
+
 The purpose of the following manual is not to promote Telegram but so people can use it with the Nym mixnet if they wish to, should a situation ask for that. This privacy-enhances Telegram at the network level and allows users to access the application from locations like where the application was banned.  
 
 See also: [Element (Matrix) over the Nym mixnet](./matrix.md): private, decentralised and secure messaging.
@@ -10,7 +12,7 @@ See also: [Element (Matrix) over the Nym mixnet](./matrix.md): private, decentra
 
 Here’s how to configure Telegram with NymConnect:
 
-1. Download and install NymConnect ().**
+1. **Download and install NymConnect(https://nymtech.net/download-nymconnect/).**
 	For more releases, check out [Github](https://github.com/nymtech/nym/tags). NymConnect is available for Linux, Windows, and MacOS.
 	On Linux make sure NymConnect is executable. Opening a terminal in the same directory and run:
 	```sh

documentation/docs/README.md

@@ -16,7 +16,7 @@ To contribute tranlsations in a new language, please get in touch via [Matrix](h
 ### Variables
 There are some variables that are shared across the entire docs site, such as the current latest software version.
 
-Variables are denoted in the `.md` files wrapped in `{{}}` (e.g `{{platform_release_version}}` is the most recent release), and are located in the `book.toml` file under the `[preprocessor.variables.variables]` heading. If you are changing something like the software release version, minimum code versions in prerequisites, etc, **check in here first!**
+Variables are denoted in the `.md` files wrapped in `{{}}` (e.g `{{wallet_release_version}}`), and are located in the `book.toml` file under the `[preprocessor.variables.variables]` heading. If you are changing something like the software release version, minimum code versions in prerequisites, etc, **check in here first!**
 
 ### Diagrams
 Most diagrams are simply ascii. Copies are kept in `/diagrams/` for ease of reproducability. Created using [textik](https://textik.com/#).
@@ -27,12 +27,6 @@ Example files are inserted as per normal with mdbook.
 
 Some binary command outputs are generated using the [`cmdrun`](https://docs.rs/mdbook-cmdrun/latest/mdbook_cmdrun/) mdbook plugin.
 
-### Updating platform version
-
-When updating the version, make sure to change **both** the version in the `title` on line 2 of `book.toml`, as well as the `platform_release_version` variable in the same file.
-
-> In the future this will be dealt with something like a preprocessor widget (todo).
-
 ## Building
 When working locally, it is recommended that you use `mdbook serve` to have a local version of the docs served on `localhost:3000`, with hot reloading on any changes made to files in the `src/` directory.
 

documentation/docs/book.toml

@@ -38,7 +38,7 @@ chapter-line-height       = "2em"
 section-line-height       = "1.5em"
 
 # if true, never read and touch the files in theme dir: this is used to stop the looping reload issue referred to in the readme
-turn-off = false
+turn-off = true
 
 [preprocessor.admonish]
 command = "mdbook-admonish"
@@ -48,7 +48,6 @@ assets_version = "2.0.0" # do not edit: managed by `mdbook-admonish install`
 # https://gitlab.com/tglman/mdbook-variables/
 [preprocessor.variables.variables]
 minimum_rust_version = "1.66"
-platform_release_version = "1.1.29"
 wallet_release_version = "1.2.8"
 
 [preprocessor.last-changed]
@@ -91,7 +90,7 @@ git-repository-icon = "fa-github"
 # edit-url-template = "https://github.com/rust-lang/mdBook/edit/master/guide/{path}"
 # site-url = "/docs/"
 # cname = "nymtech.net"
-input-404 = "not-found.md" 
+input-404 = "not-found.md"
 
 [output.html.fold]
 enable = true    # whether or not to enable section folding

documentation/docs/src/SUMMARY.md

@@ -9,8 +9,8 @@
 
 # Binaries
 - [Pre-built Binaries](binaries/pre-built-binaries.md)
+    - [Binary Initialisation and Configuration](binaries/init-and-config.md)
 - [Building from Source](binaries/building-nym.md)
-- [Binary Initialisation and Configuration](binaries/init-and-config.md)
 <!-- - [Version Compatibility Table](binaries/version-compatiblity.md) -->
 
 # Nodes

documentation/docs/src/binaries/building-nym.md

@@ -39,7 +39,7 @@ If you really don't want to use the shell script installer, the [Rust installati
 ## 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
@@ -47,10 +47,9 @@ 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 release/{{platform_release_version}} # checkout to the latest release branch: `develop` will most likely be incompatible with deployed public networks
+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
-NETWORK=sandbox cargo build --release # build your binaries with **sandbox** configuration
 ```
 
 Quite a bit of stuff gets built. The key working parts are:

documentation/docs/src/binaries/init-and-config.md

@@ -1,6 +1,13 @@
 # Binary Initialisation and Configuration
 
-All Nym binaries must first be initialised with `init` before being `run`. 
+All Nym binaries must first be made executable and initialised with `init` before being `run`. 
+
+To make a binary executable, open terminal in the same directory and run:
+
+```sh
+chmod +x <BINARY_NAME> 
+# for example: chmod +x nym-mixnode
+```
 
 The `init` command is usually where you pass flags specifying configuration arguments such as the gateway you wish to communicate with, the ports you wish your binary to listen on, etc. 
 

documentation/docs/src/clients/socks5-client.md

@@ -160,7 +160,7 @@ Create a service file for the socks5 client at `/etc/systemd/system/nym-socks5-c
 
 ```ini
 [Unit]
-Description=Nym Socks5 Client ({{platform_release_version}})
+Description=Nym Socks5 Client 
 StartLimitInterval=350
 StartLimitBurst=10
 

documentation/docs/src/clients/websocket-client.md

@@ -109,7 +109,7 @@ Alternatively, a custom host can be set in the `config.toml` file under the `soc
 ### Connecting to the local websocket
 The Nym native client exposes a websocket interface that your code connects to. To program your app, choose a websocket library for whatever language you're using. The **default** websocket port is `1977`, you can override that in the client config if you want.
 
-The Nym monorepo includes websocket client example code for Rust, Go, Javacript, and Python, all of which can be found [here](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/clients/native/examples).
+The Nym monorepo includes websocket client example code for Rust, Go, Javacript, and Python, all of which can be found [here](https://github.com/nymtech/nym/tree/master/clients/native/examples).
 
 > Rust users can run the examples with `cargo run --example <rust_file>.rs`, as the examples are not organised in the same way as the other examples, due to already being inside a Cargo project.
 
@@ -183,7 +183,7 @@ Nym [`ClientRequest`](https://github.com/nymtech/nym/blob/develop/clients/native
 
 As a response the `native-client` will send a `ServerResponse` to be decoded.
 
-You can find examples of sending and receiving binary data in the Rust, Python and Go [code examples](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/clients/native/examples), and an example project from the Nym community [BTC-BC](https://github.com/sgeisler/btcbc-rs/): Bitcoin transaction transmission via Nym, a client and service provider written in Rust.
+You can find examples of sending and receiving binary data in the Rust, Python and Go [code examples](https://github.com/nymtech/nym/tree/master/clients/native/examples), and an example project from the Nym community [BTC-BC](https://github.com/sgeisler/btcbc-rs/): Bitcoin transaction transmission via Nym, a client and service provider written in Rust.
 
 #### Getting your own address
 Sometimes, when you start your app, it can be convenient to ask the native client to tell you what your own address is (from the saved configuration files). To do this, send:

documentation/docs/src/nodes/mixnode.md

@@ -1,6 +1,6 @@
 # Mix Nodes
 
-> The mix node setup and maintenance guide has migrated to the [Operator Guides book](https://nymtech.net/developers/nodes/mix-node-setup.html).
+> The mix node setup and maintenance guide has migrated to the [Operator Guides book](https://nymtech.net/operators/nodes/mix-node-setup.html).
 
 Mix nodes are the backbone of the mixnet. These are the nodes that perform 'mix mining', otherwise known simply as 'mixing'. 
 
@@ -14,4 +14,4 @@ Mix nodes are rewarded according to their quality of service, and the probabilit
 * [Nym Whitepaper](https://nymtech.net/nym-whitepaper.pdf) section 4 
 * [Nym Blog: Mix node deepdive](https://blog.nymtech.net/nym-mixnodes-deep-dive-d2b91917f097)
 * [Mixnet Traffic Flow overview](../architecture/traffic-flow.md)
-* [Reward Sharing for Mixnets](https://nymtech.net/nym-cryptoecon-paper.pdf)
+* [Reward Sharing for Mixnets](https://nymtech.net/nym-cryptoecon-paper.pdf)

documentation/docs/src/nodes/network-requester.md

@@ -1,6 +1,6 @@
 # Network Requester
 
-> The network requester setup and maintenance guide has moved to the [Operator Guides book](https://nymtech.net/developers/nodes/network-requester-setup.html).
+> The network requester setup and maintenance guide has moved to the [Operator Guides book](https://nymtech.net/operators/nodes/network-requester-setup.html).
 
 Network requesters are the first instance of the catch-all term 'service', or 'service providers'. In essence, think of services as being the part of the mixnet infrastructure that let you _do_ something, such as access emails, messaging service backends, or blockchains via the mixnet. 
 
@@ -19,4 +19,4 @@ This default whitelist is useful for knowing that the majority of Network reques
 
 ## Further reading
 * [Nym Blog: Network Requester deepdive](https://blog.nymtech.net/tech-deepdive-network-requesters-e5359a6cc31c)
-* [Nym Blog: Choose Your Character](https://blog.nymtech.net/choose-your-character-an-overview-of-nym-network-actors-19e6a9808540)
+* [Nym Blog: Choose Your Character](https://blog.nymtech.net/choose-your-character-an-overview-of-nym-network-actors-19e6a9808540)

documentation/docs/src/nyx/mixnet-contract.md

@@ -1,6 +1,6 @@
 # Mixnet Contract
 
-The Mixnet smart contract is a core piece of the Nym system, functioning as the mixnet directory and keeping track of delegations and rewards: the core functionality required by an incentivised mixnet. You can find the code and build instructions [here](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/contracts/mixnet).
+The Mixnet smart contract is a core piece of the Nym system, functioning as the mixnet directory and keeping track of delegations and rewards: the core functionality required by an incentivised mixnet. You can find the code and build instructions [here](https://github.com/nymtech/nym/tree/master/contracts/mixnet).
 
 ### Functionality 
 The Mixnet contract has multiple functions: 
@@ -9,5 +9,5 @@ The Mixnet contract has multiple functions:
 * storing delegation and bond amounts.
 * storing reward amounts. 
 
-The addresses of deployed smart contracts can be found in the [`network-defaults`](https://github.com/nymtech/nym/blob/release/{{platform_release_version}}/common/network-defaults/src/mainnet.rs) directory of the codebase alongside other network default values.
+The addresses of deployed smart contracts can be found in the [`network-defaults`](https://github.com/nymtech/nym/blob/master/common/network-defaults/src/mainnet.rs) directory of the codebase alongside other network default values.
 

documentation/docs/src/nyx/vesting-contract.md

@@ -1,11 +1,11 @@
 # Vesting Contract
 
-The vesting contract allows for the creation of vesting accounts, allowing `NYM` tokens to vest over time, and for users to minimally interact with the Mixnet using their unvested tokens. You can find the code and build instructions [here](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/contracts/vesting). 
+The vesting contract allows for the creation of vesting accounts, allowing `NYM` tokens to vest over time, and for users to minimally interact with the Mixnet using their unvested tokens. You can find the code and build instructions [here](https://github.com/nymtech/nym/tree/master/contracts/vesting). 
 
 ### Functionality 
 The Vesting contract has multiple functions:
 * Creating and storing vesting `NYM` token vesting accounts.
 * Interacting with the Mixnet using vesting (i.e. non-transferable) tokens, allowing users to delegate their unvested tokens. 
 
-The addresses of deployed smart contracts can be found in the [`network-defaults`](https://github.com/nymtech/nym/blob/release/{{platform_release_version}}/common/network-defaults/src/mainnet.rs) directory of the codebase alongside other network default values.
+The addresses of deployed smart contracts can be found in the [`network-defaults`](https://github.com/nymtech/nym/blob/master/common/network-defaults/src/mainnet.rs) directory of the codebase alongside other network default values.
 

documentation/docs/src/sdk/rust.md

@@ -27,7 +27,7 @@ The `mixnet` component currently exposes the logic of two clients: the [websocke
 The `coconut` component is currently being worked on. Right now it exposes logic allowing for the creation of coconut credentials on the Sandbox testnet.
 
 ## Websocket client examples
-> All the codeblocks below can be found in the `nym-sdk` [examples directory](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/sdk/rust/nym-sdk/examples) in the monorepo. Just navigate to `nym/sdk/rust/nym-sdk/examples/` and run the files from there. If you wish to run these outside of the workspace - such as if you want to use one as the basis for your own project - then make sure to import the `sdk`, `tokio`, and `nym_bin_common` crates.
+> All the codeblocks below can be found in the `nym-sdk` [examples directory](https://github.com/nymtech/nym/tree/master/sdk/rust/nym-sdk/examples) in the monorepo. Just navigate to `nym/sdk/rust/nym-sdk/examples/` and run the files from there. If you wish to run these outside of the workspace - such as if you want to use one as the basis for your own project - then make sure to import the `sdk`, `tokio`, and `nym_bin_common` crates.
 
 ### Different message types
 There are two methods for sending messages through the mixnet using your client: 
@@ -82,7 +82,7 @@ If you're integrating mixnet functionality into an existing app and want to inte
 ### Anonymous replies with SURBs
 Both functions used to send messages through the mixnet (`send_message` and `send_plain_message`) send a pre-determined number of SURBs along with their messages by default.
 
-The number of SURBs is set [here](https://github.com/nymtech/nym/blob/release/{{platform_release_version}}/sdk/rust/nym-sdk/src/mixnet/client.rs#L34):
+The number of SURBs is set [here](https://github.com/nymtech/nym/blob/master/sdk/rust/nym-sdk/src/mixnet/client.rs#L33):
 
 ```rust,noplayground
 {{#include ../../../../sdk/rust/nym-sdk/src/mixnet/client.rs:34}}

documentation/docs/src/sdk/typescript.md

@@ -1,7 +1,7 @@
 # Typescript SDK
 The Typescript SDK allows developers to start building browser-based mixnet applications quickly, by simply importing the SDK into their code via NPM as they would any other Typescript library.
 
-You can find the source code [here](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/sdk) and the library on NPM [here](https://www.npmjs.com/package/@nymproject/sdk).
+You can find the source code [here](https://github.com/nymtech/nym/tree/master/sdk) and the library on NPM [here](https://www.npmjs.com/package/@nymproject/sdk).
 
 Currently developers can use the SDK to do the following **entirely in the browser**:
 * Create a client
@@ -19,7 +19,7 @@ In the future the SDK will be made up of several components, each of which will
 | Validator | Sign & broadcast Nyx blockchain transactions, query the blockchain             | ❌       |
 
 ### How it works
-The SDK can be thought of as a 'wrapper' around the compiled [WebAssembly client](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/clients/webassembly) code: it runs the client (a Wasm blob) in a web worker. This allows us to keep the work done by the client - such as the heavy lifting of creating and multiply-encrypting Sphinx packets - in a seperate thread from our UI, enabling you to build reactive frontends without worrying about the work done under the hood by the client eating your processing power.
+The SDK can be thought of as a 'wrapper' around the compiled [WebAssembly client](https://github.com/nymtech/nym/tree/master/clients/webassembly) code: it runs the client (a Wasm blob) in a web worker. This allows us to keep the work done by the client - such as the heavy lifting of creating and multiply-encrypting Sphinx packets - in a seperate thread from our UI, enabling you to build reactive frontends without worrying about the work done under the hood by the client eating your processing power.
 
 The SDK exposes an interface that allows developers to interact with the Wasm blob inside the webworker from frontend code.
 
@@ -41,7 +41,7 @@ Support for environments with different bundlers will be added in subsequent rel
 
 
 ### Using the SDK
-There are multiple example projects in [`nym/sdk/typescript/examples/`](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/sdk/typescript/examples/), each for a different frontend framework.
+There are multiple example projects in [`nym/sdk/typescript/examples/`](https://github.com/nymtech/nym/tree/master/sdk/typescript/examples/), each for a different frontend framework.
 
 #### Vanilla HTML
 The best place to start if you just want to quickly get a basic frontend up and running with which to experiment is `examples/plain-html`:
@@ -53,10 +53,10 @@ The best place to start if you just want to quickly get a basic frontend up and
 As you can see, all that is required to create an ephemeral keypair and connect to the mixnet is creating a client and then subscribing to the mixnet events coming down the websocket, and adding logic to deal with them.
 
 #### Parcel
-If you don't want to use `Webpack` as your app bundler, we have an example with `Parcel` located at [`examples/parcel/`](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/sdk/typescript/examples/react-webpack-with-theme-example/parcel/).
+If you don't want to use `Webpack` as your app bundler, we have an example with `Parcel` located at [`examples/parcel/`](https://github.com/nymtech/nym/tree/master/sdk/typescript/examples/chat-app/parcel).
 
 #### Create React App
-For React developers we have an example which is a basic React app scaffold with the additional logic for creating a client and subscribing to mixnet events in [`examples/react-webpack-with-theme-example/`](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/sdk/typescript/examples/react-webpack-with-theme-example/).
+For React developers we have an example which is a basic React app scaffold with the additional logic for creating a client and subscribing to mixnet events in [`examples/react-webpack-with-theme-example/`](https://github.com/nymtech/nym/tree/master/sdk/typescript/examples/chat-app/react-webpack-with-theme-example).
 
 ### Developers: think about what you're sending (and importing)!
 Think about what information your app sends. That goes for whatever you put into your Sphinx packet messages as well as what your app's environment may leak.

documentation/operators/book.toml

@@ -38,7 +38,7 @@ chapter-line-height       = "2em"
 section-line-height       = "1.5em"
 
 # if true, never read and touch the files in theme dir: this is used to stop the looping reload issue referred to in the readme
-turn-off = false
+turn-off = true
 
 [preprocessor.admonish]
 command = "mdbook-admonish"
@@ -48,7 +48,6 @@ assets_version = "2.0.0" # do not edit: managed by `mdbook-admonish install`
 # https://gitlab.com/tglman/mdbook-variables/
 [preprocessor.variables.variables]
 minimum_rust_version = "1.66"
-platform_release_version = "1.1.29"
 wallet_release_version = "1.2.8"
 
 [preprocessor.last-changed]

documentation/operators/src/SUMMARY.md

@@ -4,8 +4,8 @@
 
 # Binaries
 - [Pre-built Binaries](./binaries/pre-built-binaries.md)
+    - [Binary Initialisation and Configuration](./binaries/init-and-config.md)
 - [Building from Source](./binaries/building-nym.md)
-- [Binary Initialisation and Configuration](./binaries/init-and-config.md)
 <!-- - [Version Compatibility Table](binaries/version-compatiblity.md) -->
 
 # Operators Guides

documentation/operators/src/binaries/building-nym.md

@@ -39,7 +39,7 @@ If you really don't want to use the shell script installer, the [Rust installati
 ## 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
@@ -47,10 +47,9 @@ 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 release/{{platform_release_version}} # checkout to the latest release branch: `develop` will most likely be incompatible with deployed public networks
+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
-NETWORK=sandbox cargo build --release # build your binaries with **sandbox** configuration
 ```
 
 Quite a bit of stuff gets built. The key working parts are:

documentation/operators/src/binaries/init-and-config.md

@@ -1,6 +1,13 @@
 # Binary Initialisation and Configuration
 
-All Nym binaries must first be initialised with `init` before being `run`. 
+All Nym binaries must first be made executable and initialised with `init` before being `run`. 
+
+To make a binary executable, open terminal in the same directory and run:
+
+```sh
+chmod +x <BINARY_NAME> 
+# for example: chmod +x nym-mixnode
+```
 
 The `init` command is usually where you pass flags specifying configuration arguments such as the gateway you wish to communicate with, the ports you wish your binary to listen on, etc. 
 

documentation/operators/src/nodes/gateway-setup.md

@@ -97,7 +97,7 @@ It will look something like this:
      |_| |_|\__, |_| |_| |_|
             |___/
 
-             (nym-gateway - version {{platform_release_version}})
+             (nym-gateway - version v1.1.29)  
 
 
 >>> attempting to sign 2Mf8xYytgEeyJke9LA7TjhHoGQWNBEfgHZtTyy2krFJfGHSiqy7FLgTnauSkQepCZTqKN5Yfi34JQCuog9k6FGA2EjsdpNGAWHZiuUGDipyJ6UksNKRxnFKhYW7ri4MRduyZwbR98y5fQMLAwHne1Tjm9cXYCn8McfigNt77WAYwBk5bRRKmC34BJMmWcAxphcLES2v9RdSR68tkHSpy2C8STfdmAQs3tZg8bJS5Qa8pQdqx14TnfQAPLk3QYCynfUJvgcQTrg29aqCasceGRpKdQ3Tbn81MLXAGAs7JLBbiMEAhCezAr2kEN8kET1q54zXtKz6znTPgeTZoSbP8rzf4k2JKHZYWrHYF9JriXepuZTnyxAKAxvGFPBk8Z6KAQi33NRQkwd7MPyttatHna6kG9x7knffV6ebGzgRBf7NV27LurH8x4L1uUXwm1v1UYCA1WSBQ9Pp2JW69k5v5v7G9gBy8RUcZnMbeL26Qqb8WkuGcmuHhaFfoqSfV7PRHPpPT4M8uRqUyR4bjUtSJJM1yh6QSeZk9BEazzoJqPeYeGoiFDZ3LMj2jesbJweQR4caaYuRczK92UGSSqu9zBKmE45a

documentation/operators/src/nodes/maintenance.md

@@ -10,7 +10,7 @@ A `build-info` command prints the build information like commit hash, rust versi
 
 For example `./target/debug/nym-network-requester --no-banner build-info --output json` will return:
 
-```
+```sh
 {"binary_name":"nym-network-requester","build_timestamp":"2023-07-24T15:38:37.00657Z","build_version":"1.1.23","commit_sha":"c70149400206dce24cf20babb1e64f22202672dd","commit_timestamp":"2023-07-24T14:45:45Z","commit_branch":"feature/simplify-cli-parsing","rustc_version":"1.71.0","rustc_channel":"stable","cargo_profile":"debug"}
 ```
 
@@ -19,7 +19,7 @@ For example `./target/debug/nym-network-requester --no-banner build-info --outpu
 > The process is the similar for mix node, gateway and network requester. In the following steps we use a placeholder `<NODE>` in the commands, please change it for the type of node you want to upgrade. Any particularities for the given type of node are included.
 
 Upgrading your node is a two-step process:
-* Updating the binary and `~/.nym/<NODE>/<YOUR_ID>/config.toml` on your VPS
+* Updating the binary and `~/.nym/<NODE>/<YOUR_ID>/config/config.toml` on your VPS
 * Updating the node information in the [mixnet smart contract](https://nymtech.net/docs/nyx/mixnet-contract.html). **This is the information that is present on the [mixnet explorer](https://explorer.nymtech.net)**.
 
 ### Step 1: Upgrading your binary
@@ -57,25 +57,25 @@ If you are running an existing network requester registered with nym-connect, up
 
 Initiate the new network requester:
 
-```
+```sh
 nym-network-requester init --id <YOUR_ID>
 ```
 
 Copy the old keys from your client to the network-requester configuration that was created above:
 
-```
+```sh
 cp -vr ~/.nym/clients/myoldclient/data/* ~/.nym/service-providers/network-requester/<YOUR_ID>/data
 ```
 
 Edit the configuration to match what you used on your client. Specifically, edit the configuration file at:
 
-```
+```sh
 ~/.nym/service-providers/network-requester/<YOUR_ID>/config/config.toml
 ```
 
 Ensure that the fields `gateway_id`, `gateway_owner`, `gateway_listener` in the new config match those in the old client config at:
 
-```
+```sh
 ~/.nym/clients/myoldclient/config/config.toml
 ```
 
@@ -115,7 +115,8 @@ Assuming both machines are remote VPS.
 
 * Make sure your `~/.ssh/<YOUR_KEY>.pub` is in both of the machines `~/.ssh/authorized_keys` file
 * Create a `mixnodes` folder in the target VPS. Ssh in from your terminal and run:
-```
+
+```sh
 # in case none of the nym configs was created previously
 mkdir ~/.nym
 
@@ -123,7 +124,7 @@ mkdir ~/.nym
 mkdir ~/.nym/mixnodes
 ```
 * Move the node data (keys) and config file to the new machine by opening a local terminal (as that one's ssh key is authorized in both of the machines) and running:
-```
+```sh
 scp -r -3 <SOURCE_USER_NAME>@<SOURCE_HOST_ADDRESS>:~/.nym/mixnodes/<YOUR_ID> <TARGET_USER_NAME>@<TARGET_HOST_ADDRESS>:~/.nym/mixnodes/
 ```
 * Re-run init (remember that init doesn't overwrite existing keys) to generate a config with the new listening address etc.
@@ -134,7 +135,7 @@ scp -r -3 <SOURCE_USER_NAME>@<SOURCE_HOST_ADDRESS>:~/.nym/mixnodes/<YOUR_ID> <TA
 ### Configure your firewall
 Although your `<NODE>` is now ready to receive traffic, your server may not be. The following commands will allow you to set up a firewall using `ufw`.
 
-```
+```sh
 # check if you have ufw installed
 ufw version
 
@@ -150,7 +151,7 @@ sudo ufw status
 
 Finally open your `<NODE>` p2p port, as well as ports for ssh and ports for verloc and measurement pings:
 
-```
+```sh
 # for mix node
 sudo ufw allow 1789,1790,8000,22/tcp
 
@@ -165,7 +166,7 @@ sudo ufw allow 1317,26656,26660,22,80,443/tcp
 ```
 
 Check the status of the firewall:
-```
+```sh
 sudo ufw status
 ```
 
@@ -179,7 +180,7 @@ Although it’s not totally necessary, it's useful to have the mix node automati
 
 `nohup` is a command with which your terminal is told to ignore the `HUP` or 'hangup' signal. This will stop the node process ending if you kill your session.
 
-```
+```sh
 nohup ./<NODE> run --id <YOUR_ID> # where `<YOUR_ID>` is the id you set during the `init` command and <NODE> depends on which node you starting
 ```
 
@@ -207,17 +208,17 @@ No when you installed tmux on your VPS, let's run a mix node on tmux, which allo
 
 * Pause your `<NODE>`
 * Start tmux with the command 
-```
+```sh
 tmux
 ```
 * The tmux terminal should open in the same working directory, just the layout changed into tmux default layout.
 * Start the `<NODE>` again with a command:
-```
+```sh
 ./<NODE> run --id <YOUR_ID>
 ```
 * Now, without closing the tmux window, you can close the whole terminal and the `<NODE>` (and any other process running in tmux) will stay active.
 * Next time just start your teminal, ssh into the VPS and run the following command to attach back to your previous session:
-```
+```sh
 tmux attach-session
 ```
 * To see keybinding options of tmux press `ctrl`+`b` and after 1 second `?`
@@ -230,7 +231,7 @@ Here's a systemd service file to do that:
 
 ```ini
 [Unit]
-Description=Nym Mixnode ({{platform_release_version}})
+Description=Nym Mixnode <VERSION>
 StartLimitInterval=350
 StartLimitBurst=10
 
@@ -252,7 +253,7 @@ WantedBy=multi-user.target
 
 ```ini
 [Unit]
-Description=Nym Gateway ({{platform_release_version}})
+Description=Nym Gateway <VERSION>
 StartLimitInterval=350
 StartLimitBurst=10
 
@@ -274,7 +275,7 @@ WantedBy=multi-user.target
 
 ```ini
 [Unit]
-Description=Nym Network Requester ({{platform_release_version}})
+Description=Nym Network Requester <VERSION>
 StartLimitInterval=350
 StartLimitBurst=10
 
@@ -293,7 +294,7 @@ WantedBy=multi-user.target
 
 Now enable and start your requester:
 
-```
+```sh
 systemctl enable nym-network-requester.service
 systemctl start nym-network-requester.service
 
@@ -313,10 +314,10 @@ StartLimitInterval=350
 StartLimitBurst=10
 
 [Service]
-User=nyx                                                          # change to your user
+User=<USER>                                                       # change to your user
 Type=simple
-Environment="LD_LIBRARY_PATH=/home/youruser/path/to/nyx/binaries" # change to correct path
-ExecStart=/home/youruser/path/to/nyx/binaries/nymd start          # change to correct path
+Environment="LD_LIBRARY_PATH=/home/<USER>/<PATH_TO_NYX_BINARIES>" # change to correct path
+ExecStart=/home/<USER>/<PATH_TO_NYX_BINARIES>/nymd start          # change to correct path
 Restart=on-failure
 RestartSec=30
 LimitNOFILE=infinity
@@ -327,11 +328,11 @@ WantedBy=multi-user.target
 
 Proceed to start it with:
 
-```
+```sh
 systemctl daemon-reload # to pickup the new unit file
 systemctl enable nymd   # to enable the service
 systemctl start nymd    # to actually start the service
-journalctl -f           # to monitor system logs showing the service start
+journalctl -f -u nymd # to monitor system logs showing the service start
 ```
 
 ##### Following steps for Nym Mixnet nodes
@@ -344,9 +345,13 @@ If you have built nym in the `$HOME` directory on your server, and your username
 
 Then run:
 
+```sh
+systemctl daemon-reload # to pickup the new unit file
 ```
+
+```sh
 # for mix node
-systemctl enable nym-mix node.service
+systemctl enable nym-mixnode.service
 
 # for gateway
 systemctl enable nym-gateway.service
@@ -354,7 +359,7 @@ systemctl enable nym-gateway.service
 
 Start your node:
 
-```
+```sh
 # for mix node
 service nym-mixnode start
 
@@ -365,6 +370,16 @@ service nym-gateway start
 
 This will cause your node to start at system boot time. If you restart your machine, the node will come back up automatically.
 
+You can monitor system logs of your node by running:
+```sh
+journalctl -f -u <NODE>.service
+```
+
+Or check a status by running:
+```sh
+systemctl status <NODE>.service
+```
+
 You can also do `service <NODE> stop` or `service <NODE> restart`.
 
 Note: if you make any changes to your systemd script after you've enabled it, you will need to run:
@@ -383,7 +398,7 @@ Linux machines limit how many open files a user is allowed to have. This is call
 
 If you see errors such as:
 
-```
+```sh
 Failed to accept incoming connection - Os { code: 24, kind: Other, message: "Too many open files" }
 ```
 
@@ -397,8 +412,8 @@ The ulimit setup is relevant for maintenance of nym mix node only.
 
 Query the `ulimit` of your `<NODE>` with:
 
-```
-# for nym-, nym-gateway and nym-network requester:
+```sh
+# for nym-mixnode, nym-gateway and nym-network requester:
 grep -i "open files" /proc/$(ps -A -o pid,cmd|grep <NODE> | grep -v grep |head -n 1 | awk '{print $1}')/limits
 
 # for nyx validator:
@@ -409,7 +424,7 @@ grep -i "open files" /proc/$(ps -A -o pid,cmd|grep nymd | grep -v grep |head -n
 
 You'll get back the hard and soft limits, which looks something like this:
 
-```
+```sh
 Max open files            65536                65536                files
 ```
 
@@ -417,26 +432,26 @@ If your output is **the same as above**, your node will not encounter any `ulimi
 
 However if either value is `1024`, you must raise the limit via the systemd service file. Add the line:
 
-```
+```sh
 LimitNOFILE=65536
 ```
 
 Reload the daemon:
 
-```
+```sh
 systemctl daemon-reload
 ```
 
 or execute this as root for system-wide setting of `ulimit`:
 
-```
+```sh
 echo "DefaultLimitNOFILE=65535" >> /etc/systemd/system.conf
 ```
 
 Reboot your machine and restart your node. When it comes back, use:
-```
+```sh
 # for nym-mixnode, nym-gateway and nym-network requester:
-cat /proc/$(pidof <NODE>)/limits | grep "Max open files"` to make sure the limit has changed to 65535.
+cat /proc/$(pidof <NODE>)/limits | grep "Max open files"
 
 # for validator
 cat /proc/$(pidof nym-validator)/limits | grep "Max open files"
@@ -447,7 +462,7 @@ Make sure the limit has changed to 65535.
 
 In case you chose tmux option for mix node automatization, see your `ulimit` list by running:
 
-```
+```sh
 ulimit -a
 
 # watch for the output line -n
@@ -456,13 +471,13 @@ ulimit -a
 
 You can change it either by running a command:
 
-```
+```sh
 ulimit -u -n 4096
 ```
 
 or editing `etc/security/conf` and add the following lines:
 
-```
+```sh
 # Example hard limit for max opened files
 username        hard nofile 4096
 
@@ -479,7 +494,7 @@ On some services (AWS, Google, etc) the machine's available bind address is not
 
 For example, on a Google machine, you may see the following output from the `ifconfig` command:
 
-```
+```sh
 ens4: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1460
         inet 10.126.5.7  netmask 255.255.255.255  broadcast 0.0.0.0
         ...
@@ -492,7 +507,7 @@ The `ens4` interface has the IP `10.126.5.7`. But this isn't the public IP of th
 Trying `nym-mixnode init --host 36.68.243.18`, you'll get back a startup error saying `AddrNotAvailable`. This is because the mix node doesn't know how to bind to a host that's not in the output of `ifconfig`.
 
 The right thing to do in this situation is to init with a command:
-```
+```sh
 ./nym-mixnode init --host 10.126.5.7 --announce-host 36.68.243.18
 ```
 
@@ -513,13 +528,13 @@ The endpoint is a particularly common for mix node operators as it can provide a
 
 Using this API endpoint returns information about the Reward Estimation:
 
-```
+```sh
 /status/mixnode/<MIX_ID>/reward-estimation
 ```
 
 Query Response:
 
-```
+```sh
     "estimation": {
         "total_node_reward": "942035.916721770541325331",
         "operator": "161666.263307386408152071",
@@ -546,19 +561,19 @@ Query Response:
 
 Install `nginx` and allow the 'Nginx Full' rule in your firewall:
 
-```
+```sh
 sudo ufw allow 'Nginx Full'
 ```
 
 Check nginx is running via systemctl:
 
-```
+```sh
 systemctl status nginx
 ```
 
 Which should return:
 
-```
+```sh
 ● nginx.service - A high performance web server and a reverse proxy server
    Loaded: loaded (/lib/systemd/system/nginx.service; enabled; vendor preset: enabled)
    Active: active (running) since Fri 2018-04-20 16:08:19 UTC; 3 days ago
@@ -574,7 +589,7 @@ Which should return:
 
 Proxying your validator's port `26657` to nginx port `80` can then be done by creating a file with the following at `/etc/nginx/conf.d/validator.conf`:
 
-```
+```sh
 server {
   listen 80;
   listen [::]:80;
@@ -591,7 +606,7 @@ server {
 
 Followed by:
 
-```
+```sh
 sudo apt install certbot nginx python3
 certbot --nginx -d nym-validator.yourdomain.com -m you@yourdomain.com --agree-tos --noninteractive --redirect
 ```
@@ -606,7 +621,7 @@ These commands will get you an https encrypted nginx proxy in front of the API.
 
 Configure Prometheus with the following commands (adapted from NodesGuru's [Agoric setup guide](https://nodes.guru/agoric/setup-guide/en)):
 
-```
+```sh
 echo 'export OTEL_EXPORTER_PROMETHEUS_PORT=9464' >> $HOME/.bashrc
 source ~/.bashrc
 sed -i '/\[telemetry\]/{:a;n;/enabled/s/false/true/;Ta}' $HOME/.nymd/config/app.toml

documentation/operators/src/nodes/mix-node-setup.md

@@ -87,13 +87,13 @@ Mixnode configuration completed.
      |_| |_|\__, |_| |_| |_|
             |___/
 
-             (nym-mixnode - version {{platform_release_version}})
+             (nym-mixnode - version v1.1.29)
 
 
-Identity Key: DhmUYedPZvhP9MMwXdNpPaqCxxTQgjAg78s2nqtTTiNF","version":"{{platform_release_version}}"},"cost_params
+Identity Key: DhmUYedPZvhP9MMwXdNpPaqCxxTQgjAg78s2nqtTTiNF","version":"v1.1.29"},"cost_params
 Sphinx Key: CfZSy1jRfrfiVi9JYexjFWPqWkKoY72t7NdpWaq37K8Z
 Host: 62.240.134.189 (bind address: 62.240.134.189)
-Version: {{platform_release_version}}
+Version: v1.1.29
 Mix Port: 1789, Verloc port: 1790, Http Port: 8000
 ```
 ~~~
@@ -134,7 +134,7 @@ It will look something like this:
      |_| |_|\__, |_| |_| |_|
             |___/
 
-             (nym-mixnode - version {{platform_release_version}})
+             (nym-mixnode - version v1.1.29)
 
 
 >>> attempting to sign 22Z9wt4PyiBCbMiErxj5bBa4VCCFsjNawZ1KnLyMeV9pMUQGyksRVANbXHjWndMUaXNRnAuEVJW6UCxpRJwZe788hDt4sicsrv7iAXRajEq19cWPVybbUqgeo76wbXbCbRdg1FvVKgYZGZZp8D72p5zWhKSBRD44qgCrqzfV1SkiFEhsvcLUvZATdLRocAUL75KmWivyRiQjCE1XYEWyRH9yvRYn4TymWwrKVDtEB63zhHjATN4QEi2E5qSrSbBcmmqatXsKakbgSbQoLsYygcHx7tkwbQ2HDYzeiKP1t16Rhcjn6Ftc2FuXUNnTcibk2LQ1hiqu3FAq31bHUbzn2wiaPfm4RgqTwGM4eqnjBofwR3251wQSxbYwKUYwGsrkweRcoPuEaovApR9R19oJ7GVG5BrKmFwZWX3XFVuECe8vt1x9MY7DbQ3xhAapsHhThUmzN6JPPU4qbQ3PdMt3YVWy6oRhap97ma2dPMBaidebfgLJizpRU3Yu7mtb6E8vgi5Xnehrgtd35gitoJqJUY5sB1p6TDPd6vk3MVU1zqusrke7Lvrud4xKfCLqp672Bj9eGb2wPwow643CpHuMkhigfSWsv9jDq13d75EGTEiprC2UmWTzCJWHrDH7ka68DZJ5XXAW67DBewu7KUm1jrJkNs55vS83SWwm5RjzQLVhscdtCH1Bamec6uZoFBNVzjs21o7ax2WHDghJpGMxFi6dmdMCZpqn618t4

documentation/operators/src/nodes/network-requester-setup.md

@@ -190,7 +190,7 @@ Stop the running process with `CTRL-C`, and create a service file for the reques
 
 ```ini
 [Unit]
-Description=Nym Network Requester ({{platform_release_version}})
+Description=Nym Network Requester 
 StartLimitInterval=350
 StartLimitBurst=10
 

documentation/post_process.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+# this is a script called by the github CI and CD workflows to post process CSS/image/href links for serving
+# several mdbooks from a subdirectory
+
+cd scripts/post-process
+npm install
+node index.mjs

documentation/scripts/post-process/index.mjs

@@ -0,0 +1,88 @@
+import { unified } from "unified";
+import parse from "rehype-parse";
+import inspectUrls from "@jsdevtools/rehype-url-inspector";
+import stringify from "rehype-stringify";
+import { read, write } from "to-vfile";
+import path from "path";
+import fs from "fs";
+import { glob } from "glob";
+
+async function main() {
+    const distDir = "../../../dist/docs";
+
+    const items = [];
+
+    const books = [
+        'developers',
+        'docs',
+        'operators',
+    ];
+
+    for(const book of books)
+    {
+        // only process the root `index.html` files, because they have absolute paths instead of relative paths
+        const filenames = [ path.resolve(distDir, book, 'index.html') ];
+
+        // leaving this here for a future where other files need to be processed
+        // const filenames = await glob(path.resolve(distDir, book) + '/**/*.html');
+
+        for (const f of filenames) {
+            // Create a Rehype processor with the inspectUrls plugin
+            const processor = unified()
+                .use(parse)
+                .use(inspectUrls, {
+                    inspectEach(args) {
+                        const { url: rawUrl, propertyName } = args;
+                        const { tagName } = args.node;
+                        const filename = args.file.history[0];
+
+                        const relativeFilename = path.relative(distDir, filename);
+                        const relativeDirectory = path.dirname(relativeFilename);
+
+                        // remove relative paths from URL
+                        const bareUrl = rawUrl.split('/').filter(c => c !== '.' && c !== '..').join('/');
+                        let url;
+
+                        if(rawUrl.includes('.html#')) {
+                            url = path.join(`/${relativeDirectory}`, bareUrl);
+                        } else if(rawUrl.startsWith('#')) {
+                            url = path.join(`/`, relativeFilename + bareUrl);
+                        } else {
+                            url = path.join(`/${book}`, bareUrl);
+                        }
+
+                        // const item = { filename, relativeDirectory, tagName, propertyName, rawUrl, url };
+                        const item = { tagName, rawUrl, url };
+
+                        // if(tagName === 'a') {
+                        //     console.log(args);
+                        // }
+
+                        if(!rawUrl.startsWith('http')) {
+                            if (tagName === 'link' || tagName === 'script' || tagName === 'a') {
+                                args.node.properties[propertyName] = url;
+                                items.push(item);
+                            }
+                        }
+                    }
+                })
+                .use(stringify);
+
+            // Read the example HTML file
+            const filename = path.resolve(distDir, f);
+            console.log(`${filename}...`);
+
+            let file = await read(filename);
+
+            // Crawl the HTML file and find all the URLs
+            const res = await processor.process(file);
+
+            fs.writeFileSync(filename, res.value);
+        }
+    }
+
+   // console.table(items);
+   // console.log();
+}
+
+main();

documentation/scripts/post-process/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "nym-docs-post-process",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "process": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "@jsdevtools/rehype-url-inspector": "^2.0.2",
+    "glob": "^10.3.4",
+    "rehype-parse": "^9.0.0",
+    "rehype-stringify": "^10.0.0",
+    "to-vfile": "^8.0.0",
+    "unified": "^11.0.2"
+  }
+}

explorer-api/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "explorer-api"
-version = "1.1.27"
+version = "1.1.28"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

gateway/Cargo.toml

@@ -3,7 +3,7 @@
 
 [package]
 name = "nym-gateway"
-version = "1.1.27"
+version = "1.1.28"
 authors = [
     "Dave Hrycyszyn <futurechimp@users.noreply.github.com>",
     "Jędrzej Stuczyński <andrew@nymtech.net>",

mixnode/Cargo.toml

@@ -3,7 +3,7 @@
 
 [package]
 name = "nym-mixnode"
-version = "1.1.28"
+version = "1.1.29"
 authors = [
     "Dave Hrycyszyn <futurechimp@users.noreply.github.com>",
     "Jędrzej Stuczyński <andrew@nymtech.net>",

nym-api/Cargo.toml

@@ -3,7 +3,7 @@
 
 [package]
 name = "nym-api"
-version = "1.1.28"
+version = "1.1.29"
 authors = [
     "Dave Hrycyszyn <futurechimp@users.noreply.github.com>",
     "Jędrzej Stuczyński <andrew@nymtech.net>",

nym-connect/desktop/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## [Unreleased]
 
+## [v1.1.20-twix] (2023-09-05)
+
+- nym-connect directory error handling ([#3830])
+- NC - it should not be possible to toggle speedy mode while the connection is active ([#3816])
+
+[#3830]: https://github.com/nymtech/nym/pull/3830
+[#3816]: https://github.com/nymtech/nym/issues/3816
+
 ## [v1.1.19-snickers] (2023-08-29)
 
 - NymConnect sometimes fails to connect because the gateway it fetches from the validator-api to use is running an old version (of the gateway binary) ([#3788])

nym-connect/desktop/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nym/nym-connect",
-  "version": "1.1.19",
+  "version": "1.1.20",
   "main": "index.js",
   "license": "MIT",
   "scripts": {

nym-connect/desktop/src-tauri/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nym-connect"
-version = "1.1.19"
+version = "1.1.20"
 description = "nym-connect"
 authors = ["Nym Technologies SA"]
 license = ""

nym-connect/desktop/src-tauri/tauri.conf.json

@@ -1,7 +1,7 @@
 {
   "package": {
     "productName": "nym-connect",
-    "version": "1.1.19"
+    "version": "1.1.20"
   },
   "build": {
     "distDir": "../dist",

nym-wallet/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [Unreleased]
 
+## [v1.2.8] (2023-08-23)
+
+- [hotfix]: don't assign invalid fields when crossing the JS boundary ([#3805])
+
+[#3805]: https://github.com/nymtech/nym/pull/3805
+
 ## [1.2.7] (2023-08-17)
 - release due to schema changes in the contract
 

nym-wallet/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nymproject/nym-wallet-app",
-  "version": "1.2.7",
+  "version": "1.2.8",
   "main": "index.js",
   "license": "MIT",
   "scripts": {

nym-wallet/src-tauri/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nym_wallet"
-version = "1.2.7"
+version = "1.2.8"
 description = "Nym Native Wallet"
 authors = ["Nym Technologies SA"]
 license = ""

nym-wallet/src-tauri/tauri.conf.json

@@ -1,7 +1,7 @@
 {
   "package": {
     "productName": "nym-wallet",
-    "version": "1.2.7"
+    "version": "1.2.8"
   },
   "build": {
     "distDir": "../dist",

service-providers/network-requester/Cargo.toml

@@ -3,7 +3,7 @@
 
 [package]
 name = "nym-network-requester"
-version = "1.1.27"
+version = "1.1.28"
 authors.workspace = true
 edition.workspace = true
 rust-version = "1.65"

service-providers/network-statistics/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nym-network-statistics"
-version = "1.1.27"
+version = "1.1.28"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tools/nym-cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nym-cli"
-version = "1.1.27"
+version = "1.1.28"
 authors.workspace = true
 edition = "2021"