Merge pull request #388 from wcandillon/feat/docs-site

feat(📖): add documentation site

Author: wcandillon

.github/workflows/ci.yml

@@ -49,6 +49,14 @@ jobs:
       - name: Typecheck files
         run: yarn tsc
 
+      # Build the docs site the same way the Pages deploy does (GITHUB_PAGES set,
+      # so the project base path is applied) to catch broken links / build
+      # regressions before they reach main.
+      - name: Build docs
+        env:
+          GITHUB_PAGES: "true"
+        run: yarn build:docs
+
       - name: Install CocoaPods
         working-directory: apps/example/ios
         run: pod install

.github/workflows/deploy-docs.yml

@@ -0,0 +1,53 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "apps/docs/**"
+      - "packages/webgpu/src/**"
+      - ".github/workflows/deploy-docs.yml"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn install --immutable
+
+      - name: Build docs
+        env:
+          GITHUB_PAGES: "true"
+        run: yarn build:docs
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: apps/docs/out
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4