USF-4124 Move audit-docs script from dropins-mcp to microsite-commerce-storefront

.github/workflows/audit-docs.yml

@@ -0,0 +1,70 @@
+# Diffs the dropins-mcp registry against the microsite MDX documentation files
+# and opens a PR with a DOCS-GAPS.md report when gaps are found.
+#
+# Runs automatically on a weekly schedule (Mondays) and can be triggered manually.
+# Requires @dropins/mcp to be installed as a devDependency (provides the registry).
+
+name: Audit Documentation Coverage
+
+on:
+  workflow_dispatch:
+  schedule:
+    # Mondays 07:00 UTC
+    - cron: "0 7 * * 1"
+
+concurrency:
+  group: audit-docs
+  cancel-in-progress: true
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  audit:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout microsite
+        uses: actions/checkout@v4
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v3
+        with:
+          version: 10
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ".nvmrc"
+          cache: "pnpm"
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Run doc audit
+        run: |
+          # Exit 1 means gaps found (expected); any other non-zero exit is a real error.
+          pnpm run audit:docs --output-path DOCS-GAPS.md || \
+          { code=$?; [ $code -eq 1 ] && exit 0 || exit $code; }
+
+      - name: Open or update PR with gap report
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: "docs: update documentation gap report"
+          title: "docs: fix documentation gaps [auto]"
+          body: |
+            Automated gap report from the **Audit Documentation Coverage** workflow.
+
+            The `DOCS-GAPS.md` file lists every prop, function, slot, event, and i18n key
+            that is present in the dropin registry but missing from the microsite docs (or vice versa).
+
+            **To resolve:** fix the missing documentation entries, then re-run the workflow to confirm the gaps are cleared.
+
+            > Generated by [`scripts/audit-docs.ts`](scripts/audit-docs.ts)
+            > Registry source: `@dropins/mcp` (installed devDependency)
+          branch: chore/docs-gaps-audit
+          delete-branch: true
+          add-paths: DOCS-GAPS.md
+          labels: "documentation,automated"

package.json

@@ -38,6 +38,7 @@
     "update-all-versions": "npm run update-boilerplate-versions && npm run update-dropin-versions",
     "generate-all-docs": "node scripts/generate-all-docs.js",
     "generate-boilerplate-docs": "node scripts/@generate-boilerplate-docs.js",
+    "audit:docs": "tsx scripts/audit-docs.ts",
     "validate-diagrams": "node scripts/validate-diagrams.js",
     "verify-enrichments": "node scripts/verify-enrichments.js",
     "validate-b2b-enrichments": "node scripts/validate-b2b-enrichments.js",
@@ -167,9 +168,11 @@
     ]
   },
   "devDependencies": {
+    "@dropins/mcp": "^0.1.0",
     "eslint-plugin-mdx": "^3.2.0",
     "jsdom": "^25.0.1",
     "playwright": "^1.57.0",
+    "tsx": "^4.21.0",
     "vite": "7.3.2"
   },
   "engines": {