Skip to content

Commit

Permalink
Add instructions about npm run validatespec
Browse files Browse the repository at this point in the history
  • Loading branch information
kordwarshuis committed Aug 26, 2024
1 parent 98a717a commit 4774aa3
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions docs/various-roles/general-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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
```

Expand Down

0 comments on commit 4774aa3

Please sign in to comment.