Github Page setup #5

Author: AlchemiistCreative

.github/workflows/deploy.yml

@@ -31,22 +31,20 @@ jobs:
         run: npm ci
 
       - name: Build VitePress docs
-        run: npm run docs:build
+        run: npx vitepress build docs --base /docs/
 
-      - name: Merge static root into VitePress dist
+      - name: Compose site
         run: |
-          OUT=docs/.vitepress/dist
-          # s’assure que le dossier existe (VitePress le crée, mais au cas où)
-          mkdir -p "$OUT"
-          # copie le site statique racine dans la sortie VitePress
-          cp -r index.html assets "$OUT"/
-          # évite l’interférence Jekyll sur Pages
-          touch "$OUT"/.nojekyll
+          mkdir -p dist
+          cp -r index.html assets dist/
+          # custom domain + nojekyll
+          echo "openhvx.org" > dist/CNAME || true
+          touch dist/.nojekyll
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: docs/.vitepress/dist
+          path: dist
 
   deploy:
     environment:

docs/.vitepress/config.ts

@@ -1,33 +1,32 @@
 import { defineConfig } from "vitepress";
 
-// https://vitepress.dev/reference/site-config
 export default defineConfig({
   lang: "en-US",
   title: "OpenHVX Docs",
   description:
     "Open-source IaaS for Hyper-V — multi-tenant, API-first, agent-based automation.",
 
-  base: "/docs/", // hébergé sous openhvx.org/docs
+  // Docs are served from /docs/ on the site
+  base: "/docs/",
+
+  // Build docs directly into ../dist/docs so GitHub Pages can serve both root and /docs/.
+  outDir: "../dist/docs",
 
   themeConfig: {
-    logo: "/assets/logo.svg",
+    logo: "/assets/logo.svg", // uses the root site's /assets (you copy it to dist/)
     siteTitle: "OpenHVX",
     outline: [2, 3],
     lastUpdated: true,
-    search: {
-      provider: "local",
-    },
+    search: { provider: "local" },
 
-    // --- Navbar ---
     nav: [
-      { text: "Home", link: "/" },
+      { text: "Home", link: "/" }, // goes to the landing page at site root
       { text: "Architecture", link: "/architecture" },
       { text: "API", link: "/api" },
       { text: "Agents", link: "/agents" },
       { text: "GitHub", link: "https://github.com/openhvx" },
     ],
 
-    // --- Sidebar ---
     sidebar: [
       {
         text: "Getting Started",
@@ -70,13 +69,11 @@ export default defineConfig({
       },
     ],
 
-    // --- Social Links ---
     socialLinks: [
       { icon: "github", link: "https://github.com/openhvx" },
       { icon: "twitter", link: "https://x.com/OpenHVX" },
     ],
 
-    // --- Footer ---
     footer: {
       message: "Released under the Apache-2.0 License.",
       copyright: "© 2025 OpenHVX. Built with ❤️ by the community.",