Skip to content

Commit e29a9b3

Browse files
Update readme
1 parent e1f430c commit e29a9b3

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,15 @@ Run the build script to generate `.json` files from all `.jsonnet` files in the
6161
npm run buildJson
6262
```
6363

64-
### 3. Validate output completeness
64+
### 3. Build Mermaid diagrams
65+
66+
Run the build script to generate `.mmd` diagrams from all `.json` files in the `generated/json` directory:
67+
68+
```bash
69+
npm run buildDiagrams
70+
```
71+
72+
### 4. Validate output completeness
6573

6674
Check that all `.jsonnet` files have corresponding `.json` outputs:
6775

@@ -77,8 +85,9 @@ To define a new logging feature:
7785

7886
1. Create a `.jsonnet` file under `features/<your-feature>/`
7987
2. Run `npm run buildJson` to generate the `.json` file
80-
3. Add a test under `__tests__/<your-feature>.test.js`
81-
4. Run `npm test` to validate
88+
3. Run `npm run buildDiagrams` to generate the `.mmd` file
89+
4. Add a test under `__tests__/<your-feature>.test.js`
90+
5. Run `npm test` to validate
8291

8392
---
8493

0 commit comments

Comments
 (0)