Files
nym/documentation/README.md
T
Tommy Verrall 22c59be82c Release/v1.1.30 twix (#3836)
* changed last vers. checkout to master

* corrected path of config

* make binaries executable

* docs: typescript.md - changing variables

* docs: rust.md - changing variables

* docs: vesting-contract.md - changing variables

* docs: mixnet-contract.md - changing variables

* docs: all variables changed

* operators: all variables finished

* dev-portal: mixnet-integration.md - variable changed

* dev-portal: faq.md - variable changed

* dev-portal: moredo.md up to date w NC default

* dev-portal: telegram.md - added banner & minor fix

* dev-portal: matrix.md - added banner

* PR finished - ready for review and merge

* removed all instances of platform_release_version var

* removed all instances of platform_release_version var

* changed version bumper script: removed platform_release_version references

* changed comment

* updating changelog and bumping versions

---------

Co-authored-by: serinko <97586125+serinko@users.noreply.github.com>
Co-authored-by: mfahampshire <maxhampshire@pm.me>
Co-authored-by: mx <33262279+mfahampshire@users.noreply.github.com>
Co-authored-by: benedettadavico <benedetta.davico@gmail.com>
2023-09-05 11:58:21 +02:00

1.1 KiB

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.