Files
nym/documentation

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.
  • post_process.sh is a script called by the github CI and CD workflows to post process CSS/image/href links for serving several mdbooks from a subdirectory.

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:

  • applications and binaries are GPLv3
  • libraries and components are Apache 2.0 or MIT
  • documentation is Apache 2.0 or CC0-1.0

For accurate information, please check individual files.