feat(docs): generate reference API site and publish to GitHub Pages on publish

Author: mikehardy

.github/workflows/publish.yml

@@ -64,3 +64,25 @@ jobs:
           # org admin Github Token required for the changelog/tag commit+push
           # to work via an exception to branch protection rules
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+      - name: Build API reference (TypeDoc)
+        run: yarn reference:api:gh-pages
+      - name: Upload API reference artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./apidocs-out
+
+  deploy-api-docs:
+    name: "Github Pages"
+    needs: publish_npm
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

.gitignore

@@ -539,6 +539,7 @@ packages/**/version.js
 packages/**/version.ts
 typedoc.raw.json
 reference/
+apidocs-out/
 tests/ios/Firebase
 tests/ios/resetXcode.sh
 .tmp