Jędrzej Stuczyński
114d92f93f
* changed NymConfigTemplate trait to call 'template' by reference * network requester lib * introduced generic parameter to 'MixTrafficController' to allow non-remote gateways * allowing for custom gateway sender * types cleanup * minor gateway cmds refactor + initial NR work * wip * running a NR inside gateway note: this NR isnt tied to the gateway yet * rebase fixes * propagating same shutdown handle * wip * starting NR with appropriate local transceiver * fixed premature shutdown * wiring up PacketRouter * both ends wired together * actually working so much cleanup to do now * started removing dead code * wip * temp: hardcode gateway * further cleanup * fixed build of other binaries * setup-network-requester subcmd * overriding NR config in gateway init/run * wip making it wasm-compatible [again] * refactored 'GatewaySetup' * clippy and friends * removed debug code * rust 1.72 lints * ensuring local gateway is available + some comments * correctly putting network requester data in the same underlying details struct * improved gateway errors * changed 'network_requester_config' deserialization * missing clap annotation for 'enabled' flag in 'setup-network-requester' command * saving config file after 'setup-network-requester' * removed dead code * review comments * make embedded NR wait for gateway to come online (for at most 70min) * fixed shutdown on successful gateway wait * updated NR config override
Nym Developer Portal
Developer Portal for the Nym privacy platform built using the mdBook docs framework. Deployed version can be found here.
Contributing
Contributions to our documentation are very welcome. Please work on your contribution in either a feature/<feature-name> or chore/<chore-name> branch from master and target your pull request at master.
Changes merged to master will be autodeployed to the production site.
Adding community projects and resources
If you have built a project with Nym or are compiling and writing resources about Nym, we want to include your work in the community-resources/ section to share with the rest of the community! Just follow the existing formatting and add your project to the page, then put in a pull request.
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 {{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.
You can find other commands in the mdBook CLI tool docs.
I tried to edit files in theme/ and they aren't taking effect / mdbook serve causes a looping reload on file changes after changing fields in [preprocessor.theme] config
Looping reload is a known issue with the mdbook-theme preprocessor used for the table of contents and layout of these docs. As outlined in the mdbook-theme readme one way to mitigate this is to set turn-off = true under [preprocessor.theme]. This means that mdbook serve or mdbook watch ignores changes to the theme/ directory, which is the source of the looping reload. If you have changed or commented out this line, reintroduce it to remove the looping reload. If you are trying to edit the theme of the docs and want to apply the change, see here for more info on how to remove the block, change the theme, and reintroduce the block.