GRIN/nym
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
mfahampshire
2024-10-15 16:45:10 +02:00
parent 3638ddf398
commit 3fcd2191ee
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/README.md
+3 -4
View File
@@ -14,12 +14,11 @@ These docs are hosted at [nymtech.net/docs](www.nymtech.net/docs).
* If you wish to add to the documentation please create a PR against this repo, with a `patch` against `develop`.
## Scripts
There are several autogenerated command files for clients and binaries. These are generated with `generate:commands`, which runs the `autodoc` rust binary, moves the files to their required places, and then if there is an update, commits them to git. This is for remote deployments.
* There are several autogenerated command files for clients and binaries. These are generated with `generate:commands`, which runs the `autodoc` rust 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
## CI/CD
Deployment of the docs is partially automated and partially manual.
* `ci-docs.yml` will run on pushes to all branches **apart from `master`**
* `cd-docs.yml` must be run manually. This pushes to a staging branch which then must be manually promoted to production.
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.