From 4774aa3d314c23de4dd0495484ade5f0896c05b1 Mon Sep 17 00:00:00 2001 From: kor Date: Mon, 26 Aug 2024 10:57:16 +0200 Subject: [PATCH] Add instructions about npm run validatespec --- docs/various-roles/general-guide.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/various-roles/general-guide.md b/docs/various-roles/general-guide.md index fc504ee3..a108f94f 100644 --- a/docs/various-roles/general-guide.md +++ b/docs/various-roles/general-guide.md @@ -6,11 +6,23 @@ sidebar_position: 3 These are general instructions for every role involved. +#### Test `spec.json` + +Once you have edited the `spec.json,` you can test here to see if it is OK; that is, it checks whether each key is present. It does not check whether the value of the key meets specific rules: + +```bash +npm run validatespec +``` + +If a key is missing you will get a notification about it. + + + #### Look up xrefs Xrefs are [To Do: write explanation] -``` +```bash npm run xrefs ``` @@ -20,7 +32,7 @@ Now, the references to external specs are generated, if any. The final result will be just one file: `index.html`. This file is rendered or re-rendered with the following command: -``` +```bash npm run render ```