From 5b909b27e4e088dbcd965b717292b1f8a1b71e30 Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Tue, 15 Oct 2024 21:56:25 +0200 Subject: [PATCH] update readme --- documentation/docs/README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/documentation/docs/README.md b/documentation/docs/README.md index 52b8287343..a00c077935 100644 --- a/documentation/docs/README.md +++ b/documentation/docs/README.md @@ -9,7 +9,15 @@ npm i npm run dev ``` -Open http://localhost:3000 to browse the output that will hot-reload when you make changes. +Open `http://localhost:3000` to browse the output that will hot-reload when you make changes. + +If you are cutting a new version with binaries that have updated commands (and you have updated the command list in `autodocs`) run: + +``` +npm generate:commands +``` + +This will regenerate the md command files for the binaries, move them into position, and then commit them to the branch head. ## Build @@ -19,6 +27,14 @@ npm run build The static output will be in `./out`; +If you are cutting a new version with binaries that have updated commands (and you have updated the command list in `autodocs`) **run this first**: + +``` +npm generate:commands +``` + +This will regenerate the md command files for the binaries, move them into position, and then commit them to the branch head. + ## Template details This documentation was made with [Nextra](https://nextra.site) using the template from here https://github.com/shuding/nextra-docs-template.