serinko
dafed3ad58
* add CC BY-NC-SA 4.0 license * syntax edit * update licenses * update licenses * update licenses * update licenses * add cc-by-nc-sa-4.0 license * edit wss && automation flow * edit wss && automation flow * correct path * correct phrasing * small tweak to format and licensing phrase * delete and replace --anounce-host * clarify and edit systemd automation * clarify and edit systemd automation * clarify and edit systemd automation --------- Co-authored-by: mfahampshire <maxhampshire@pm.me>
2.8 KiB
2.8 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).
docscontains technical documentation hosted at https://nymtech.net/docsdev-portalcontains developer documentation hosted at https://nymtech.net/developersoperatorscontains node setup and maintenance guides hosted at https://nymtech.net/operators
Scripts
bump_versions.shallows you to update theplatform_release_versionandwallet_release_versionvariablesin thebook.tomlof each mdbook project at once. You can also optionally update theminimum_rust_versionas well. Helpful for lazy-updating when cutting a new version of the docs.build_all_to_dist.shis used by theci-dev.ymlandcd-dev.ymlscripts for building all mdbook projects and moving the rendered html to../dist/to be rsynced with various servers.post_process.shis a script called by the github CI and CD workflows to post process CSS/image/href links for serving several mdbooks from a subdirectory.
Licensing
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
For accurate information, please check individual files.