diff --git a/documentation/README.md b/documentation/README.md index 7dd1ec620d..3330b3e969 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -3,4 +3,4 @@ * `docs` contains technical documentation hosted at [https://nymtech.net/docs](https://nymtech.net/docs) * `dev-portal` contains developer documentation hosted at [https://nymtech.net/developers](https://nymtech.net/developers) -Each is built with [`mdbook`](https://rust-lang.github.io/mdBook/index.html) - use `mdbook serve` to build and serve them (defaults to `localhost:3000`). +Each directory contains a readme with more information about running and contributing to the projects. Each is built with [`mdbook`](https://rust-lang.github.io/mdBook/index.html) - use `mdbook serve` to build and serve them (defaults to `localhost:3000`). diff --git a/documentation/dev-portal/book.toml b/documentation/dev-portal/book.toml index fde3d0942c..90bae91f82 100644 --- a/documentation/dev-portal/book.toml +++ b/documentation/dev-portal/book.toml @@ -49,9 +49,9 @@ assets_version = "2.0.0" # do not edit: managed by `mdbook-admonish install` [preprocessor.variables.variables] # code prerequisites versions minimum_rust_version = "1.66" -platform_release_version = "v1.1.16" -upcoming_platform_release_version = "v1.1.17" # to use when adding 'edit on github' plugin -mix_node_release_version = "v1.1.17" +platform_release_version = "v1.1.17" +upcoming_platform_release_version = "v1.1.18" # to use when adding 'edit on github' plugin +mix_node_release_version = "v1.1.18" # [preprocessor.last-changed] command = "mdbook-last-changed" diff --git a/documentation/docs/book.toml b/documentation/docs/book.toml index bb0b74cbf0..10caa07784 100644 --- a/documentation/docs/book.toml +++ b/documentation/docs/book.toml @@ -1,5 +1,5 @@ [book] -title = "Nym Docs v1.1.16" +title = "Nym Docs v1.1.17" authors = ["Max Hampshire"] description = "Nym technical documentation" language = "en" @@ -48,11 +48,9 @@ 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 = "v1.1.16" -upcoming_platform_release_version = "v1.1.17" # to use in 'edit page on github' plugin (coming soon) -mix_node_release_version = "v1.1.17" -# used by the cmdrun preprocessor - relative path from inside src/ -# binaries_path = '../../../../target/release/' +platform_release_version = "v1.1.17" +upcoming_platform_release_version = "v1.1.18" # to use in 'edit page on github' plugin (coming soon) +mix_node_release_version = "v1.1.18" [preprocessor.last-changed] command = "mdbook-last-changed" diff --git a/documentation/docs/src/nodes/gateway-setup.md b/documentation/docs/src/nodes/gateway-setup.md index 4f37dfd1b7..356c6a5eb8 100644 --- a/documentation/docs/src/nodes/gateway-setup.md +++ b/documentation/docs/src/nodes/gateway-setup.md @@ -14,7 +14,7 @@ Before you initialise and run your gateway, head to our [website](https://nymtec If you don't already have one, please create a Nym address using the wallet, and fund it with tokens. The minimum amount required to bond a gateway is 100 `NYM`, but make sure you have a bit more to account for gas costs. -`NYM` can be purchased via Bity from the wallet itself, and is currently present on several exchanges. +`NYM` can be purchased via Bity from the wallet itself with BTC or fiat, and is currently present on several exchanges. > Remember that you can **only** use native Cosmos `NYM` tokens to bond your gateway. You **cannot** use ERC20 representations of `NYM` to run a node. diff --git a/documentation/docs/src/nodes/mix-node-setup.md b/documentation/docs/src/nodes/mix-node-setup.md index 123edc726a..3c5f574e37 100644 --- a/documentation/docs/src/nodes/mix-node-setup.md +++ b/documentation/docs/src/nodes/mix-node-setup.md @@ -21,7 +21,7 @@ Before you initialise and run your mixnode, head to our [website](https://nymtec If you don't already have one, please create a Nym address using the wallet, and fund it with tokens. The minimum amount required to bond a mixnode is 100 `NYM`, but make sure you have a bit more to account for gas costs. -`NYM` can be purchased via Bity from the wallet itself, and is currently present on several exchanges. +`NYM` can be purchased via Bity from the wallet itself with BTC or fiat, and is currently present on several exchanges. > Remember that you can **only** use Cosmos `NYM` tokens to bond your mixnode. You **cannot** use ERC20 representations of `NYM` to run a node. @@ -122,7 +122,7 @@ You can bond your mix node via the Desktop wallet. |_| |_|\__, |_| |_| |_| |___/ - (nym-mixnode - version 1.1.14) + (nym-mixnode - version {{mix_node_release_version}}) >>> attempting to sign 5XrvVEMzRJk2AcT2h1o6ErZNb8z1ZzD3h7teipBW3NUtrtYq7vu4DRMgzZRTPVPnyr2YWCxpmKCMFaEXvksnJ4jt7np3NMLxsLMrFjEBhh67Crtjy4868vCzAivUqzdc365RiqxQQKtv4r9eTk9mTbE9JY8U3TxzKJCSGcBqbrb9JX3HrZVWm6tqbUYbsnku9pqnfeyeUiaYKY44Lm72TYrkZfRrMAZLMATiXT1ntmiKqT37HzRxNZjiH8qHeQEoRHkgDsmXDXRbfppGTpPrN7R4sjynJzehzUBZ8Ug7ovT9FoAHb8kuVQhUiMs1js6tdwtthzQMbPi9vwxUtVvjYknN2fnJgMnckEhzJJpJDCNdH7YhpPaWQnGVVS334mskiuqkbRVrFPJN2nnwArHr3L2cLxSMk9toKfw7ViKJ2p5E5JxiSmKY1cFGZ7uRLsuQ833PJN9JE8crPtkBNefqkbFNz68S5jPmzUShSvAc4TqXKeovDASFmmhKaPqLUrfsSWm7nzuKnzJSMADF6xSuwr9cknMoirqkRkLe7ybJ2ERwSdf5cUxMjF7yjS8tW9hZudnTUb1uPNDuSmPPVrCR12XZyFzBvVgxH51ZNJTym46nqnfA881LQcmFMnCwJf39rVJ4ASLnzEzmuwXj75QoB9ce9kiLmoBNLYe4QKSB6gDd858VnBtBNQELVuCCZbrTYuSCeNdUFhvMwD4kryc1pBYUa8Ro81F3QVfiKN diff --git a/documentation/docs/src/sdk/rust.md b/documentation/docs/src/sdk/rust.md index c8c0cb1c14..1408d85faa 100644 --- a/documentation/docs/src/sdk/rust.md +++ b/documentation/docs/src/sdk/rust.md @@ -27,7 +27,7 @@ The `mixnet` component currently exposes the logic of two clients: the websocket 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. +> 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. Lets look at a very simple example of how you can import and use the websocket client in a piece of Rust code (`examples/simple.rs`):