Website

The project website is a static page in the Proof style with the install commands, the animated illustrations and this documentation under /docs/. GitHub Pages serves it at https://satunix.github.io/luna/.

What is published

Path Source Built by
/ website/index.html, website/site.css, website/favicon.svg packages/core/build-site.ts
/assets/luna-*.svg docs/assets/luna-*.svg packages/core/build-site.ts (copied)
/docs/ docs/ and mkdocs.yml python -m mkdocs build --strict --site-dir _site/docs

build-site.ts fills the page's {{TAG}} and {{VERSION}} placeholders with the newest pushed v* tag that is merged into the built commit and not above the package.json version, so the install command on the page always names a tag that exists. A release branch bumps package.json before its tag can be pushed, so between that merge and the tag push the page keeps the previous release and the pages build prints a Release tag missing warning. Pushing the tag does not redeploy the site on its own; the release steps re-run the pages workflow (Releasing). A checkout with no usable tag, or an unknown or unfilled placeholder, fails the build. It writes only into an empty output directory.

The page runs no script. Its content security policy allows images and styles from the site itself, and the two typefaces (Archivo and Martian Mono) from Google Fonts; nothing else loads from another origin. The documentation uses the same tokens (docs/assets/proof-docs.css) and the same fonts, and loads no syntax highlighter.

tests/site-smoke.ts pins this: it builds the site in memory, checks which tag the page names (the newest pushed one, with the pending release reported), that every placeholder is filled, that the page has no script and every local link and image resolves. Nothing in the test suite pins the illustrations or the documentation theme; pages.yml runs node packages/core/readme-art.ts --check before it deploys.

Illustrations

The README, the documentation home and the website share six animated SVGs in docs/assets/: luna-hero (the README and documentation hero), luna-session (its session panel alone, the website's hero), luna-firewall, luna-delegation, luna-verify and luna-profiles, each with a -dark variant for a <picture> element. They are generated by packages/core/readme-art.ts and must not be edited by hand:

node packages/core/readme-art.ts            # regenerate docs/assets/luna-*.svg
node packages/core/readme-art.ts --check    # exit 1 if a committed file is stale

They are animated with CSS keyframes only, so they play at the display's own frame rate and resolution wherever an <img> shows an SVG, including a GitHub README. They load nothing: text uses font stacks (Archivo first where it is installed, then Helvetica or Arial, and a system monospace), so the lettering differs slightly between systems. A viewer who prefers reduced motion sees each loop paused on its finished frame.

Deployment

.github/workflows/pages.yml builds the site and deploys it from main, on each push and on a manual run (the deploy job, in the github-pages environment). It never runs on a pull request: there, ci.yml checks the same build (smoke:site builds the page and checks its links, docs-build runs mkdocs build --strict). The deploy job is the only one with pages: write and id-token: write, and it checks out no code. tests/release-workflow-smoke.ts pins that shape.

Pages must be enabled once by an administrator: Settings → Pages → Build and deployment → Source: GitHub Actions, which creates the github-pages environment. Its deployment branch rule is main, as .github/expected-settings.json declares and the settings drift check (npm run settings:check) compares. Until Pages is enabled the deploy job fails and the links to the website from the README do not resolve.

Not covered

  • The site hosts no release files: installs come from the git tag, and release notes and source archives are on GitHub Releases.
  • The documentation is the main branch's, not a per-release copy.
  • No test renders the page in a browser; the smoke test checks its structure only.