Publish docs/ to GitHub Pages with navigable index

Completed on May 19, 2026 at 9:38 AM ET.

Summary

Added an automated docs publishing flow to GitHub Pages and generated a new docs/index.html browsing experience so docs are easy to navigate at /islandflow/docs/.

Changes Made

Context

The repository already stores operational and implementation documentation under docs/, but there was no dedicated GitHub Pages pipeline and no curated index page for discovery. This task focused on syncing that folder to Pages and making it easy to browse by category and filename.

Important Implementation Details

Relevant Diff Snippets

Snippets are shown in a compact style aligned with diffs.com presentation patterns.

+++ .github/workflows/docs-pages.yml
name: Publish Docs
on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "scripts/generate-docs-index.mjs"
      - ".github/workflows/docs-pages.yml"
  workflow_dispatch:

jobs:
  build:
    steps:
      - uses: actions/checkout@v4
      - uses: actions/configure-pages@v5
      - run: node scripts/generate-docs-index.mjs
      - run: cp -R docs/. site/docs/
      - uses: actions/upload-pages-artifact@v3
  deploy:
    needs: build
    steps:
      - uses: actions/deploy-pages@v4
+++ scripts/generate-docs-index.mjs
const files = await collectDocsFiles(docsDir);
const html = renderDocument(files);
await fs.writeFile(outputFile, html, "utf8");

// Generated index features:
// - grouped sections
// - search filter
// - file size and modified time metadata
// - links preserving docs folder structure

Expected Impact for End-Users

Validation

Issues, Limitations, and Mitigations

Follow-up Work