Mark Sinclair
a0178d28f7
* wasm: mix-fetch: remove harbour master client and use Nym API client * wasm: mix-fetch: fix up internal tester * Release Typescript SDK v1.4.1 * remove bump version tool from workspace * ts-sdk: contract clients: update and re-run autogen * ts: fix linting errors * update go * pin minimatch typings to fix lint errors * bump versions to rc * Update publish-sdk-npm.yml * Update publish-sdk-npm.yml * Update publish-sdk-npm.yml * Update publish-sdk-npm.yml * try disable typedoc because of minimatch errors * bump versions to rc0 * limit packages published to only wasm clients * TS SDK 1.4.1-rc1 * simplify version dependencies and add dist to dev mode * add back version complexity for CI * TS SDK 1.4.1-rc2 * ts-sdk: fix minimatch dependency and correct casing on `selfAddress` function call * wasm: rename `main` to `main_js` to avoid collision errors in exporting main from tests see https://github.com/wasm-bindgen/wasm-bindgen/issues/2206 * improve wasm js tests * TS SDK 1.4.1-rc3 * update example docs * TS SDK 1.4.1 release * update docs dependencies to SDK 1.4.1 * update yarn lock file after TS SDK 1.4.1 publish * Update ci-lint-typescript.yml * Update ci-lint-typescript.yml * Update ci-nym-wallet-storybook.yml * Bump node tester version and add additional yarn install step to fix linting --------- Co-authored-by: Mark Sinclair <mmsinclair@users.noreply.github.com>
Nym Docs v2
This is v2 of the nym docs, condensed from various mdbooks projects that we had previously.
These docs are hosted at nymtech.net/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.
Binary dependencies
If you don't want/need build our binaries in Rust localy you can download them from latest Release page on github into target/release in root of this repo. {'nym-node', 'nym-api', 'nymvisor'}
Make them executable
chmod +x target/release/*
Serve Local (Hot Reload)
pnpm i
pnpm run dev
Open http://localhost:3000.
Build
pnpm run build
The static output will be in ./out;
Contribution
- If you wish to add to the documentation please create a PR against this repo, with a
patchagainstdevelop.
Scripts
- There are several autogenerated command files for clients and binaries. These are generated with
generate:commands, which runs theautodocrust binary, moves the files to their required places, and then if there is an update, commits them to git. This is for remote deployments. - Python scripts TODO
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.
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