feat: add GitHub Actions workflow for auto-deploying documentation to GitHub Pages

Signed-off-by: kaifcoder <kaifmohd2014@gmail.com>

Author: kaifcoder

.github/workflows/docs.yml

@@ -0,0 +1,48 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - 'docs/**'
+      - 'package.json'
+      - '.github/workflows/docs.yml'
+  workflow_dispatch: {}
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: true
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+
+      - name: Install deps
+        run: npm ci
+
+      - name: Build VitePress site
+        env:
+          VITEPRESS_BASE: /create-polyglot/
+        run: npm run docs:build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4

README.md

@@ -132,3 +132,6 @@ Preview production build:
 npm run docs:preview
 ```
 Docs source lives in `docs/` with sidebar-driven structure defined in `docs/.vitepress/config.mjs`.
+
+### Deployment
+Docs are auto-deployed to GitHub Pages on pushes to `main` that touch `docs/` via `.github/workflows/docs.yml`. The base path is set using `VITEPRESS_BASE=/create-polyglot/`.

docs/.vitepress/config.mjs

@@ -1,6 +1,10 @@
 import { defineConfig } from 'vitepress';
 
 export default defineConfig({
+  // Adjust base for GitHub Pages project site. When deploying under
+  // https://<user>.github.io/<repo>/ the base must be '/<repo>/'. The workflow
+  // sets VITEPRESS_BASE automatically; local dev stays '/'.
+  base: process.env.VITEPRESS_BASE || '/',
   title: 'create-polyglot',
   description: 'Scaffold polyglot microservice monorepos (Node, Python, Go, Java, Next.js)',
   head: [