Comments from NicK

Author: crandmck

.github/workflows/publish-docs.yml

@@ -28,7 +28,7 @@ jobs:
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - uses: pnpm/action-setup@v4
         name: Install pnpm

docs/.gitignore

@@ -6,3 +6,4 @@ vendor
 Gemfile.lock
 
 globals.md
+

docs/README.md

@@ -1,12 +1,12 @@
 # API documentation for CAI Node.js library
 
-The files in these directories are generated by TypeDoc (except for `index.md`). Do not edit them:
+The files in these directories are generated by TypeDoc (except for `index.md`). The files are generated into these directories in the workflow ONLY; they are not checked in:
 
 - `classes`
 - `functions`
 - `interfaces`
 - `type-aliases`
 
-All the other files under `/docs` are used to scaffold the Jekyll site.
+All the other files under `/docs` (which are checked in) are used to scaffold the Jekyll site.
 
 The `publish-docs.yml` workflow runs TypeDoc, runs Jekyll, and publishes the resulting HTML using GitHub Pages.