From 7e21ce614a0f0045d171da27354fe1d5b5417c8f Mon Sep 17 00:00:00 2001 From: Lea Anthony Date: Mon, 24 Nov 2025 21:33:15 +1100 Subject: [PATCH] fix(docs): disable broken d2 diagram and fix installer --- .github/workflows/v3-docs.yml | 5 +- docs/astro.config.mjs | 10 +-- .../content/docs/concepts/build-system.mdx | 69 ++----------------- docs/src/content/docs/index.mdx | 2 +- 4 files changed, 15 insertions(+), 71 deletions(-) diff --git a/.github/workflows/v3-docs.yml b/.github/workflows/v3-docs.yml index d76765907..c70bffb8a 100644 --- a/.github/workflows/v3-docs.yml +++ b/.github/workflows/v3-docs.yml @@ -26,9 +26,12 @@ jobs: uses: actions/checkout@v4 - name: Install D2 run: | - curl -fsSL https://d2lang.com/install.sh | sh -s -- + curl -fsSL https://d2lang.com/install.sh > install.sh + chmod +x install.sh + ./install.sh sudo cp ~/.local/bin/d2 /usr/local/bin/d2 d2 --version + rm install.sh - name: Install, build, and upload your site output uses: withastro/action@v2 with: diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 024a3cfa4..7529ea4e5 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -37,11 +37,11 @@ export default defineConfig({ editLink: { baseUrl: "https://github.com/wailsapp/wails/edit/v3-alpha/docs", }, - social: { - github: "https://github.com/wailsapp/wails", - discord: "https://discord.gg/JDdSxwjhGf", - "x.com": "https://x.com/wailsapp", - }, + social: [ + { icon: 'github', label: 'GitHub', href: 'https://github.com/wailsapp/wails' }, + { icon: 'discord', label: 'Discord', href: 'https://discord.gg/JDdSxwjhGf' }, + { icon: 'x.com', label: 'X', href: 'https://x.com/wailsapp' }, + ], head: [ { tag: 'script', diff --git a/docs/src/content/docs/concepts/build-system.mdx b/docs/src/content/docs/concepts/build-system.mdx index 51adf4cdd..0f9d80b29 100644 --- a/docs/src/content/docs/concepts/build-system.mdx +++ b/docs/src/content/docs/concepts/build-system.mdx @@ -19,72 +19,13 @@ wails3 build ## Build Process Overview -```d2 -direction: down +{/* +TODO: Fix D2 diagram generation or embed as image. +The previous D2 code block was causing MDX parsing errors in the build pipeline. +*/} -Source: "Source Code" { - Go: "Go Code\n(main.go, services)" { - shape: rectangle - style.fill: "#00ADD8" - } - - Frontend: "Frontend Code\n(HTML/CSS/JS)" { - shape: rectangle - style.fill: "#8B5CF6" - } -} +**[Build Process Diagram Placeholder]** -Analysis: "Analysis Phase" { - ScanGo: "Scan Go Services" { - shape: rectangle - } - - ExtractTypes: "Extract Types" { - shape: rectangle - } -} - -Generation: "Generation Phase" { - GenBindings: "Generate TypeScript Bindings" { - shape: rectangle - style.fill: "#10B981" - } - - BuildFrontend: "Build Frontend\n(Vite/webpack)" { - shape: rectangle - style.fill: "#8B5CF6" - } -} - -Compilation: "Compilation Phase" { - CompileGo: "Compile Go\n(with optimisations)" { - shape: rectangle - style.fill: "#00ADD8" - } - - EmbedAssets: "Embed Frontend Assets" { - shape: rectangle - style.fill: "#10B981" - } -} - -Output: "Output" { - Binary: "Native Binary\n(myapp.exe/.app)" { - shape: rectangle - style.fill: "#10B981" - } -} - -Source.Go -> Analysis.ScanGo -Analysis.ScanGo -> Analysis.ExtractTypes -Analysis.ExtractTypes -> Generation.GenBindings -Generation.GenBindings -> Source.Frontend: "TypeScript types" -Source.Frontend -> Generation.BuildFrontend -Generation.BuildFrontend -> Compilation.EmbedAssets: "Bundled assets" -Source.Go -> Compilation.CompileGo -Compilation.CompileGo -> Compilation.EmbedAssets -Compilation.EmbedAssets -> Output.Binary -``` ## Build Phases diff --git a/docs/src/content/docs/index.mdx b/docs/src/content/docs/index.mdx index 503061bc8..c5f1c8790 100644 --- a/docs/src/content/docs/index.mdx +++ b/docs/src/content/docs/index.mdx @@ -21,7 +21,7 @@ hero: icon: open-book variant: secondary --- - +{/* Updated 2025-11-23 */} import { Tabs, TabItem, Card, CardGrid } from "@astrojs/starlight/components";