fix(docs): deployment paths mismatch (#9067)

also adds the favicon

Co-authored-by: joshistoast <me@joshcorbett.com>
Co-authored-by: Lincoln Stein <lincoln.stein@gmail.com>

Author: 3 people

.github/workflows/deploy-docs.yml

@@ -10,6 +10,14 @@ on:
       - 'opened'
       - 'synchronize'
   workflow_dispatch:
+    inputs:
+      deploy_target:
+        description: 'Deploy target (custom = invoke.ai, ghpages = invoke-ai.github.io/InvokeAI)'
+        type: choice
+        options:
+          - custom
+          - ghpages
+        default: custom
 
 permissions:
   contents: read
@@ -68,6 +76,8 @@ jobs:
       - name: build docs
         run: pnpm build
         working-directory: docs
+        env:
+          DEPLOY_TARGET: ${{ inputs.deploy_target || 'custom' }}
 
       # Upload artifact for deploy (main branch only)
       - name: upload pages artifact

docs/astro.config.mjs

@@ -8,11 +8,16 @@ import starlightLlmsText from 'starlight-llms-txt';
 import starlightChangelogs, { makeChangelogsSidebarLinks } from 'starlight-changelogs';
 // import starlightContextualMenu from 'starlight-contextual-menu';
 
+// Deployment target: 'custom' (default, custom domain at invoke.ai) or 'ghpages'
+// (GitHub Pages project URL at invoke-ai.github.io/InvokeAI). Drive site/base from this
+// so the same source can be deployed to either target.
+const deployTarget = process.env.DEPLOY_TARGET ?? 'custom';
+const isGhPages = deployTarget === 'ghpages';
+
 // https://astro.build/config
 export default defineConfig({
-  site: 'https://invoke.ai',
-  // base is only needed if no custom domain is available, or if the site is hosted in a subdirectory
-  // base: '/InvokeAI',
+  site: isGhPages ? 'https://invoke-ai.github.io' : 'https://invoke.ai',
+  base: isGhPages ? '/InvokeAI' : undefined,
   integrations: [
     starlight({
       // Content
@@ -24,7 +29,7 @@ export default defineConfig({
         alt: 'InvokeAI Logo',
         replacesTitle: true,
       },
-      favicon: './src/assets/invoke-icon.svg',
+      favicon: '/favicon.svg',
       editLink: {
         baseUrl: 'https://github.com/invoke-ai/InvokeAI/edit/main/docs',
       },
@@ -117,10 +122,17 @@ export default defineConfig({
         PageFrame: './src/layouts/PageFrameExtended.astro',
       },
       plugins: [
-        starlightLinksValidator({
-          errorOnRelativeLinks: false,
-          errorOnLocalLinks: false,
-        }),
+        // The links validator is skipped for the ghpages target because content uses
+        // root-absolute links (e.g. /concepts/...) that don't include the /InvokeAI base.
+        // Production (custom domain) still enforces link validation.
+        ...(isGhPages
+          ? []
+          : [
+              starlightLinksValidator({
+                errorOnRelativeLinks: false,
+                errorOnLocalLinks: false,
+              }),
+            ]),
         starlightLlmsText(),
         starlightChangelogs(),
         // starlightContextualMenu({

docs/public/CNAME

@@ -0,0 +1 @@
+invoke.ai