Feature/auto commit api doc changes

.github/workflows/build-docs.yml

@@ -0,0 +1,41 @@
+name: build docs
+on:
+  push:
+    branches:
+      - main
+jobs:
+  build-api-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: 'lts/*'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build API docs
+        run: npm run docs:build
+
+      - name: Checkout documentation repository
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.DOCS_DEPLOY_GHP }}
+          repository: 'dice-roller/documentation'
+          path: './documentation'
+
+      - name: Copy API docs to documentation repository
+        run: |
+          rm -rf ./documentation/docs/api
+          mv ./docs/api ./documentation/docs/api
+
+      - name: Commit and push API doc changes
+        uses: EndBug/add-and-commit@v9
+        with:
+          cwd: './documentation'
+          add: './docs/api'
+          message: 'Auto API update from github workflow'

.github/workflows/build.yml

@@ -21,7 +21,7 @@ jobs:
           node-version: 'lts/*'
 
       - name: Install dependencies
-        run: npm install
+        run: npm ci
 
       - name: Run tests
         run: npm run test:coverage
@@ -44,7 +44,7 @@ jobs:
           node-version: 'lts/*'
 
       - name: Install dependencies
-        run: npm install
+        run: npm ci
 
       - name: Build Typescript
         run: npm run build:declaration
@@ -61,7 +61,7 @@ jobs:
           node-version: 'lts/*'
 
       - name: Install dependencies
-        run: npm install
+        run: npm ci
 
       - name: Build API docs
         run: npm run docs:build

docs/readme.md

@@ -0,0 +1,6 @@
+# Introduction
+
+The technical API is for people wanting to delve a bit deeper into the classes that make up the library.
+
+* If you want to get set up quickly, you should start with the [guide](../guide/readme.md).
+* If you just want to roll some dice, check out the [notations](../guide/notation/readme.md).

package.json

@@ -70,7 +70,7 @@
     "rollup-plugin-banner": "^0.2.1",
     "rollup-plugin-terser": "^7.0.2",
     "typescript": "^4.8.4",
-    "vuepress-jsdoc": "^4.3.0"
+    "vuepress-jsdoc": "^5.0.0"
   },
   "dependencies": {
     "mathjs": "^11.2.1",
@@ -86,7 +86,7 @@
     "build:dev": "npm run build:prepare && rollup --c --environment BUILD:dev",
     "build:grammars": "peggy -c ./peggy.config.cjs ./src/parser/grammars/grammar.pegjs",
     "build:prod": "npm run build:prepare && rollup --c --environment BUILD:prod",
-    "docs:build": "vuepress-jsdoc --dist ./docs --folder api --exclude=\"index.js,**/index.js,**/parser/grammars/*\" --partials=\"./docs/partials/**/*.hbs\"",
+    "docs:build": "vuepress-jsdoc --dist ./docs --folder api --exclude=\"index.js,**/index.js,**/parser/grammars/*\" --partials=\"./docs/partials/**/*.hbs\" --readme=\"./docs/readme.md\"",
     "docs:watch": "npm run docs:build -- --watch",
     "watch": "npm run build:dev -- -w",
     "lint": "eslint src/** tests/**",