mx
276d4318be
* auto commit generated command files * added to autodoc.sh: build all binaries before running * autodoc move individual command outputs to components
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.
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. - 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