docs: prerender documentation site content (#318)

Hoping to fix some SEO issues with the Docsify CSR site. Instead of
going full SSR, we are just prerendering the docs content and serving
that via GitHub pages.

Author: jahvon

.execs/docs.flow

@@ -2,6 +2,31 @@
 visibility: public
 tags: [docs]
 executables:
+  - verb: start
+    name: site
+    aliases: [docs]
+    description: Run the documentation site locally (from prerendered content)
+    serial:
+      dir: //
+      execs:
+        - ref: build docs
+        - cmd: npx serve dist -l 3000
+
+  - verb: start
+    name: docsify
+    description: Run the documentation site locally using the docsify CLI
+    exec:
+      dir: //
+      cmd: docsify serve docs --open
+
+  - verb: build
+    name: docs
+    description: Prerender docsify documentation site for the project
+    exec:
+      dir: //
+      cmd:
+        node ./scripts/prerender.js
+
   - verb: show
     name: flowfile
     aliases: [executables, exec, executable]

.execs/setup.flow

@@ -18,14 +18,6 @@ executables:
       dir: //
       cmd: go install ./...
 
-  - verb: start
-    name: site
-    aliases: [docs]
-    description: Run the documentation site locally
-    exec:
-      dir: //
-      cmd: docsify serve docs --open
-
   - verb: start
     name: recording
     aliases: [vhs]

.github/workflows/release.yaml

@@ -31,12 +31,19 @@ jobs:
       - name: Generate docs
         run: |
           go run ./tools/docsgen/.
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+      - run: npm install docsify-server-renderer@^4
+      - name: Prerender Docsify
+        run: node tools/prerender.js
       - name: Setup Pages
         uses: actions/configure-pages@v5
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v4
         with:
-          path: 'docs/'
+          path: 'dist/'
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@main

.gitignore

@@ -6,6 +6,8 @@
 *.dylib
 .DS_Store
 
+node_modules/
+
 # Test binary, built with `go test -c`
 *.test
 

package-lock.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "docsify-server-renderer": "^4.13.1"
+  }
+}