smoke test

Author: teogeb

.github/workflows/test-docs.yml

@@ -22,3 +22,6 @@ jobs:
       - name: Build documentation
         working-directory: ./docs
         run: npm ci && npm run build
+      - name: API docs smoke test
+        working-directory: ./docs
+        run: ./api-docs-smoke-test.sh

docs/api-docs-smoke-test.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# If TypeDoc succeeds, it creates the directory with markdown files that Docusaurus uses to generate the API docs.
+# If TypeDoc fails, Docusaurus ignores the error, builds the site without API docs, and the "npm run build"
+# script still returns 0. This is why this separate smoke test is needed.
+
+if [ ! -d "docs/usage/sdk/api" ]; then
+    echo 'No files in "docs/usage/sdk/api" directory. Maybe TypeDoc failed?'
+    exit 1
+fi