docs: documentation site built with Angular SSR, deployed to GitHub Pages

.github/workflows/docs.yml

@@ -0,0 +1,58 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'packages/docs/**'
+      - '.github/workflows/docs.yml'
+      - 'package.json'
+      - 'package-lock.json'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: docs
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Build and prerender
+        run: npx nx build docs --configuration=production --skip-nx-cache
+      - name: Prepare GitHub Pages artifact
+        # Unknown routes fall back to the app shell and `.nojekyll` keeps Pages from ignoring files that start with an underscore.
+        run: |
+          cp dist/packages/docs/browser/index.csr.html dist/packages/docs/browser/404.html
+          touch dist/packages/docs/browser/.nojekyll
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: dist/packages/docs/browser
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+    if: github.repository == 'push-based/user-flow'
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -49,3 +49,5 @@ vite.config.*.timestamp*
 vitest.config.*.timestamp*
 .cursor/rules/nx-rules.mdc
 .github/instructions/nx.instructions.md
+
+.angular

.prettierignore

@@ -5,4 +5,5 @@
 
 /.nx/cache
 /.nx/workspace-data
+.angular
 /e2e/nx-plugin-e2e/fixtures

README.md

@@ -3,6 +3,8 @@
 
 [![npm](https://img.shields.io/npm/v/%40push-based%2Fuser-flow.svg)](https://www.npmjs.com/package/%40push-based%2Fuser-flow)
 
+📖 **Documentation:** [push-based.github.io/user-flow](https://push-based.github.io/user-flow/)
+
 ---
 
 ### This is a library & CLI to organize and run Lighthouse user flows in an organized and scalable way 🛸 with CI automation in place

nx.json

@@ -39,11 +39,21 @@
         "registry": "https://registry.npmjs.org/",
         "access": "public"
       }
+    },
+    "@angular/build:application": {
+      "cache": true,
+      "dependsOn": ["^build"],
+      "inputs": ["production", "^production"]
     }
   },
   "generators": {
     "@push-based/user-flow-nx-plugin:target": {
       "targetName": "user-flow"
+    },
+    "@nx/angular:application": {
+      "e2eTestRunner": "none",
+      "style": "scss",
+      "unitTestRunner": "none"
     }
   },
   "nxCloudAccessToken": "MDlmODg4OTQtYWVlZC00OGVkLTgyMjktMDc3OWQ5ZjU1ZTAxfHJlYWQtd3JpdGU=",