From d907165ff1c2a548a128f02f8a12e8110deb12dd Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Tue, 15 Oct 2024 16:51:50 +0200 Subject: [PATCH] update readme --- documentation/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/documentation/README.md b/documentation/README.md index 0d5319a9ea..6ccca605b4 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -17,6 +17,9 @@ These docs are hosted at [nymtech.net/docs](www.nymtech.net/docs). * 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 +### Autodoc +`autodoc` is a script that generates markdown files containing commands and their output (both command and `--help` output). For the moment the binaries and their commands are manually configured in the script. + ## CI/CD TODO