rename job

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

.github/workflows/nodejs.yml

@@ -164,8 +164,8 @@ jobs:
       - name: use type declarations
         run: npm run build
         working-directory: ${{ env.EXAMPLE_DIR }}
-  api-docs:
-    name: gen API docs ${{ matrix.target }}
+  typedoc:
+    name: typedocs ${{ matrix.target }}
     runs-on: "ubuntu-latest"
     strategy:
       fail-fast: false
@@ -187,5 +187,5 @@ jobs:
           cache-dependency-path: "**/package-lock.json"
       - name: setup project
         run: npm ci --ignore-scripts
-      - name: gen API docs ${{ matrix.target }}
-        run: npm run doc:${{ matrix.target }}
+      - name: typedoc ${{ matrix.target }}
+        run: npm run typedoc:${{ matrix.target }}

README.md

@@ -138,7 +138,7 @@ bom.metadata.component.dependencies.add(componentA.bomRef)
 There is no pre-rendered documentation at the time.  
 Instead, there are annotated type definitions, so that your IDE and tools may pick up the documentation when you use this library downstream.
 
-Additionally, there is a prepared set of configs for [TypeDoc](https://typedoc.org), so that you can build the API documentation from source via `npm run doc`.
+Additionally, there is a prepared set of configs for [TypeDoc](https://typedoc.org), so that you can build the API documentation from source via `npm run typedoc`.
 
 ## Development & Contributing
 

package.json

@@ -90,8 +90,8 @@
     "test:node": "mocha -p",
     "test:web": "node -e 'console.log(\"TODO: write web test\")'",
     "test:standard": "eslint .",
-    "doc": "run-p --aggregate-output -lc doc:*",
-    "doc:node": "typedoc --options typedoc.node.json",
-    "doc:web": "typedoc --options typedoc.web.json"
+    "typedoc": "run-p --aggregate-output -lc typedoc:*",
+    "typedoc:node": "typedoc --options typedoc.node.json",
+    "typedoc:web": "typedoc --options typedoc.web.json"
   }
 }