Files
nym/documentation
Jędrzej Stuczyński 114d92f93f Feature/gateway inbuilt nr (#3877)
* 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
2023-09-20 15:47:05 +01:00
..
2023-09-19 12:54:36 +02:00
2023-09-05 11:58:21 +02:00

Documentation

Doc projects

Each directory contains a readme with more information about running and contributing to the projects. Each is built with mdbook - use mdbook serve to build and serve them (defaults to localhost:3000).

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.