mfahampshire
2ff5c7221a
* Debug logging * Yield based logging * Reintroduce non-dummy task manager, try add counting for BatchMessageSender, a couple of compiler target introductions on use statements. * Fixed time runtime err * Uncomment forgetme/rememberme * remove diffs from debug * missed commented out forgetme * yet more forgetme comments * * Added missing clientreqestsender clone to wasm client to stop premature drop & busyloop * Removed hacky mem::forget fix * Remove debug panic_hook * Conditional import + use of wasm_utils::console_log * add wasm_util dep * Commenting out or removing debug logging * Remove missed comment * cleanup gitignore * clippy * update go version in ci * removed unused deps * add clippy ignore * remove mixfetch from ci build * add minifetch fix * comment out unused ts builds * stop contract clients killing ci for the moment * wasm target locking for imports * Either remove console_log! macro or introduce cfg(debug_assertions) * downgrade netlink * debug assertions for console_log import * modify config logging (debug -> normal) * remove clone for client_request_sender + grab directly in struct creation * reintroduce debug print for config in debug mode * remove ood / unused custom topology from worker example file * clippy * clippy - ignore todo() tests * modified humantime test in line with new parsing rules
Nym Docs v2
This is v2 of the nym docs, condensed from various mdbooks projects that we had previously.
These docs are hosted at nym.com/docs.
Doc projects
docs/pages/ contains several subdirs, each hosting a subsection of the docs:
networkcontains key concepts, cryptosystems, architecture.developerscontains key concepts for developers, required architecture, and Rust/Typescript SDK docs.operatorscontains node setup and maintenance guides.
Local development
Dependencies
Our prebuild script relies on the following:
Otherwise make sure to have node installed.
Serve Local (Hot Reload)
pnpm i
pnpm run dev
Open http://localhost:3000.
Build
pnpm run build
Contribution
- If you wish to add to the documentation please create a PR against this repo, with a
patchagainstdevelop.
Scripts
generate:commands: generates command output files for clients and binaries. This script runs theautodocrust binary, moves the files to their required places, and then if there is an update, commits them to git. We commit the files as our remote deployments pull from a git repo. Only run this script on branches where you want to push e.g. the build info of a binary to production docs; it will build the monorepo binaries and use their command output for the produced markdown files.generate:tables: generates various information tables containing some repo-wide variables and information about ISPs.
Autodoc
autodoc is a script that generates markdown files containing commands and their output (both command and --help output). For the moment the binaries and their commands are manually configured in the script.
Only run this script on branches where you want to push e.g. the build info of a binary to production docs; it will build the monorepo binaries and use their command output for the produced markdown files.
CI/CD
TODO
Licensing and copyright information
This is a monorepo and components that make up Nym as a system are licensed individually, so for accurate information, please check individual files.
As a general approach, licensing is as follows this pattern:
-
Nym Documentation by Nym Technologies is licensed under CC BY-NC-SA 4.0
-
Nym applications and binaries are GPL-3.0-only
-
Used libraries and different components are Apache 2.0 or MIT