network contains key concepts, cryptosystems, architecture.
developers contains key concepts for developers, required architecture, and Rust/Typescript SDK docs.
operators contains node setup and maintenance guides.

Contribution

If you wish to add to the documentation please create a PR against this repo, with a patch against develop.

Scripts

There are several autogenerated command files for clients and binaries. These are generated with generate:commands, which runs the autodoc rust binary, moves the files to their required places, and then if there is an update, commits them to git. This is for remote deployments.

CI/CD

Deployment of the docs is partially automated and partially manual.

ci-docs.yml will run on pushes to all branches apart from master
cd-docs.yml must be run manually. This pushes to a staging branch which then must be manually promoted to production.

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