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).

If you are looking for the Typescript SDK documentation located at sdk.nymtech.net this can be found in ../sdk/typescript/docs/

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.
  • The following scripts are used by the ci-dev.yml and cd-dev.yml scripts:
    • build_all_to_dist.sh is used for building all mdbook projects and moving the rendered html to ../dist/ to be rsynced with various servers.
    • post_process.sh is used to post process CSS/image/href links for serving several mdbooks from a subdirectory.
    • removed_existing_config.sh is used to remove existing nym client/node config files on the CI/CD server so avoid mdbook-cmdrun command errors.