Skip to content

DEPLOY.md

Latest commit

 

History

History
111 lines (81 loc) · 4.32 KB

DEPLOY.md

File metadata and controls

111 lines (81 loc) · 4.32 KB
file_type documentation
description Deployment guide for LightSpeedWP Agency site on GitHub Pages
name Deployment Guide
version 1.0.0
last_updated 2026-06-05

Deploy — LightSpeedWP Agency site on GitHub Pages

Static site with an Astro build step. GitHub Pages serves the built static files from website/dist/.

Agent: fill in every <…> placeholder and tick the checklist. Do NOT change the Pages source branch or push a gh-pages branch — that is decided and applied by the repo owner, not you.

1. Repo

  • Repository: lightspeedwp/.github
  • Default branch: develop
  • Work branch for this conversion: feat/github-pages-static
  • Live URL (custom domain from CNAME): https://github.lightspeedwp.agency/
  • Live URL (GitHub Pages default): https://lightspeedwp.github.io/

2. GitHub Pages settings (configured by existing workflow)

The repository uses an automated GitHub Pages workflow (.github/workflows/awesome-github-site.yml) that:

  • Builds website/dist/ via Astro on each push to develop
  • Uploads the artefact via actions/upload-pages-artifact
  • Deploys automatically via actions/deploy-pages

No manual Pages configuration needed. The workflow handles build and deployment.

Deployment mode:

  • If custom domain (CNAME) is configured: deployed at root of custom domain (https://github.lightspeedwp.agency/)
  • If using GitHub Pages default: deployed at / (not under /<repo>/ subpath)
  • All asset paths are root-absolute (/fonts/..., /favicon.svg)

3. Entry point & folder

  • Site entry point is index.html at the served root (website/dist/index.html after build)
  • All site files live under website/dist/ after build step

4. Required files (verify present)

  • .nojekyll at website/public/.nojekyll — stops Jekyll stripping _-prefixed files
  • index.html — entry point at root after build
  • colors_and_type.css — homepage.css imported with all design tokens
  • ds-chrome.js — theme toggle and navigation interactivity bundled in JS
  • homepage/ assets — all Homepage components present and compiled
  • Fonts/images/logos — all resolve from website/public/ and compiled into website/dist/

5. Pre-deploy checklist

  • Build step required: npm run build generates website/dist/ output
  • No type="text/babel" left untranspiled — Astro pre-compiles all JSX/JS
  • No window.claude.* that throws — window.claude.complete() has fallback for static host
  • Every src / href / url() is root-absolute or relative (no subpath-relative)
  • Internal page-to-page links work from root (/)
  • Light/dark theme behaviour works with inline script; no console errors

6. Build & test locally

Run the build and serve the output to verify:

cd website/
npm install --legacy-peer-deps
npm run build

# Start a static server from the dist folder
cd dist/
python3 -m http.server 8000
# Then open http://localhost:8000/
  • Every page loads, no 404s in the Network tab
  • Theme toggle works and persists via localStorage
  • Planner shows fallback content (no AI errors)
  • Fonts load correctly (/fonts/*.woff2)
  • No console errors

7. After merge

After merging to develop:

  1. The GitHub Pages workflow (.github/workflows/awesome-github-site.yml) automatically runs
  2. It builds website/dist/ and uploads the artefact
  3. Pages deploys the artefact to the configured domain
  4. Verify live at https://github.lightspeedwp.agency/ (or configured custom domain)

Re-run the §5 checks live:

  • Verify favicon, fonts, and all assets load correctly
  • Test light/dark theme toggle
  • Planner fallback works (no console errors)

Deployment Summary

Component Status Location
Astro build ✅ Ready website/astro.config.mjs
Source files ✅ Ready website/src/pages/ (homepage now at /index.astro)
Output folder ✅ Ready website/dist/ (auto-built by workflow)
Assets ✅ Ready website/public/fonts/, website/public/favicon.svg
Fonts ✅ Ready @font-face with /fonts/ paths in homepage.css
GitHub Pages ✅ Ready Workflow handles automatic deployment on merge to develop

No manual deployment needed. The GitHub Pages workflow is already configured and will deploy automatically.