From ff38f04b3093120694208342a58a811287143af9 Mon Sep 17 00:00:00 2001
From: paulfouquet <86932794+paulfouquet@users.noreply.github.com>
Date: Fri, 11 Oct 2024 11:03:19 +1300
Subject: [PATCH] build: add script to generate readme files (#1105)

#### Motivation

I want a simplier command to generate the readme files. `npm run docs`
after running `npm run build`

#### Modification

- add a `docs` script

#### Checklist

_If not applicable, provide explanation of why._

- [ ] Tests updated
- [ ] Docs updated
- [ ] Issue linked in Title
---
 .github/workflows/push.yml | 2 +-
 package.json               | 1 +
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml
index dd0cc0b6..7cc599a9 100644
--- a/.github/workflows/push.yml
+++ b/.github/workflows/push.yml
@@ -10,7 +10,7 @@ jobs:
 
       - name: Generate Readme
         run: |
-          node build/src/readme/readme.generate.js
+          npm run docs
 
       # Validate no READMEs have been updated
       - name: Validate Readme generation
diff --git a/package.json b/package.json
index a5a8ae26..0d3eaf9c 100644
--- a/package.json
+++ b/package.json
@@ -20,6 +20,7 @@
   },
   "scripts": {
     "build": "tsc",
+    "docs": "node build/src/readme/readme.generate.js",
     "lint": "npx eslint . --ignore-path .gitignore",
     "test": "node --test build/"
   },