From 3fcd2191eee4b9ef1c81008fa1902f31125d8a86 Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Tue, 15 Oct 2024 16:45:10 +0200 Subject: [PATCH] update readme --- documentation/README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/documentation/README.md b/documentation/README.md index 7d7bcae372..0d5319a9ea 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -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.