Skip to content

Website maintenance

This website uses the same basic technical model as the Luuster site: a custom Astro landing page, Starlight for documentation, and GitHub Actions for deployment to GitHub Pages.

Requires Node.js 22.12 or newer.

Terminal window
npm install
npm run dev

The local site is available at http://localhost:4321 by default.

Terminal window
npm run check
npm run build
npm run preview

The repository is expected to be:

byteworkshop/byteworkshop.github.io

The included workflow builds with:

SITE_URL: https://byteworkshop.dev

No project BASE_PATH is required because this is the Byteworkshop organization Pages repository and the production site uses the custom apex domain.

In the repository:

  1. Open Settings → Pages.
  2. Set Source to GitHub Actions.
  3. Set the custom domain to byteworkshop.dev.
  4. Push the site to main.
  5. After GitHub validates the DNS and provisions the certificate, enable Enforce HTTPS.

The domain ownership verification TXT record is organization-level and should remain in DNS.

When a project is ready for the public catalog:

  1. Add or update its card in src/pages/index.astro.
  2. Add an organization-level summary under src/content/docs/docs/projects/.
  3. Add the page to the Starlight sidebar in astro.config.mjs if it deserves a dedicated docs page.
  4. Link to the project’s own product site and repository rather than duplicating detailed project documentation here.