wtclaude
fe4abe0ebf
All checks were successful
PR checks / checks (pull_request) Successful in 9m9s
PLAN.md §7: swapping a logo or recolouring the site is a file copy and a container restart, never a rebuild. Phase 2 builds the mechanism and the checks that keep it true. GET /brand/* resolves every file against the mount first and the baked-in defaults second, per file, at stable unhashed URLs with an ETag and a five minute TTL. Nothing goes through Vite, which would fingerprint the names out of the mount's reach. An X-Brand-Source header says which step answered. Three decisions were taken with the org lead (recorded as D14-D16 in §7): D14 — one raster in, every size out. brand-default holds a single logo.png; the header mark at three pixel ratios, both install icons, the apple-touch icon, the favicons and a real multi-resolution favicon.ico are derived on request from whichever logo.png is in force, cached, and limited to an allowlist of sizes. Shipping fifteen precomputed files would have meant an operator producing fifteen to change a mark — and getting a new header with the old favicon. D15 — brand text is applied at boot. Pages are prerendered, so §7's promise about the site name, tagline and links could not hold at render time. npm start now runs scripts/applyBrand.mjs first, rewriting the built HTML from what it last applied to what the mount says. It rewrites from a record in dist/.brand-applied.json rather than from the defaults, because the naive version works exactly once and then silently ignores every later edit. An empty mount is a no-op; removing a mount restores the stock build byte for byte. Verified both ways, plus a second rename. D16 — the header shows the real emblem, replacing phase 1's placeholder glyph, so the site, the product and the Android launcher icon are one mark. It is raster art, so theme.css cannot recolour it; replacing logo.png is how the mark changes. Two defects found and fixed while proving it: The mounted theme.css did not win. Astro emits its own stylesheet after the head markup, so linking the operator's last was not enough and every override was silently a no-op. tokens.css now lives in @layer tokens and the mounted file is unlayered, which takes order out of the mechanism entirely. The documentation was a different site. Starlight builds its own head, so the docs linked a Starlight default /favicon.svg that does not exist here, carried no manifest or OG card, and never loaded the brand stylesheet — a mounted theme recoloured the marketing pages and left the docs stock. A Head override fixes it; half a rebrand looks like a product bug rather than a missed step. brand-default/wordmark.svg and og-image.png are generated by scripts/buildBrandAssets.mjs from the emblem and Cinzel's outlines and are committed, so CI needs neither the artwork nor a font. Type is converted to paths, because an SVG in an <img> can see neither the page's @font-face rules nor fontconfig — the same isolation that broke currentColor in phase 1. Its glyphs are drawn at the origin and translated: opentype.js emits NaN coordinates at a non-zero origin for some glyphs, and a path parser stops at the first malformed command, so the first lockup read "Runic Gate" and looked like a typo rather than a bug. scripts/checkBrand.mjs is the mechanism for the two failures that are otherwise silent: it puts every literal /brand/... URL in the source through the route's own classifier, so a size that is not on the allowlist fails the build instead of 404ing in a browser, and it rejects a brand string short enough that a blind replacement at boot could corrupt a page. Negative-tested three ways before being trusted. It runs in CI ahead of the type check. Co-Authored-By: Claude <noreply@anthropic.com>
68 lines
2.8 KiB
JavaScript
68 lines
2.8 KiB
JavaScript
// @ts-check
|
|
import { defineConfig } from 'astro/config';
|
|
import node from '@astrojs/node';
|
|
import starlight from '@astrojs/starlight';
|
|
|
|
import { docsSidebar } from './src/config/sidebar.mjs';
|
|
|
|
/**
|
|
* PLAN.md §6 calls this "Astro with the Node adapter, `output: 'server'` with per-page
|
|
* `prerender = true`". Astro 7 expresses that shape the other way round: `output: 'static'`
|
|
* with an adapter prerenders everything and lets individual routes opt OUT with
|
|
* `export const prerender = false`. The runtime result is identical to what §6 describes —
|
|
* a container serving prerendered HTML, with a handful of routes executing per request —
|
|
* and this is the direction the framework supports, so the default is the safe one: a page
|
|
* added without thinking about it is static, not accidentally server-rendered.
|
|
*
|
|
* The two routes that will opt out live in phases 2 and 5: `GET /brand/*` (§7) and
|
|
* `POST /api/beta-signup` (§8).
|
|
*/
|
|
export default defineConfig({
|
|
site: 'https://runicgateway.com',
|
|
output: 'static',
|
|
adapter: node({ mode: 'standalone' }),
|
|
|
|
build: {
|
|
// Directory-style URLs, so every link in prose can end in a slash and mean it.
|
|
format: 'directory',
|
|
},
|
|
|
|
integrations: [
|
|
starlight({
|
|
title: 'Runic Gateway',
|
|
// Marketing owns the 404 (§10); a Starlight-chrome 404 on `/features/` would be wrong.
|
|
disable404Route: true,
|
|
// Not a file in `public/`: the brand route derives this from whichever `logo.png` is
|
|
// mounted (§7), so the docs' tab icon changes with a rebrand like everything else.
|
|
// Starlight's default is `/favicon.svg`, which does not exist here — every docs page
|
|
// was requesting a 404 for it.
|
|
favicon: '/brand/favicon.ico',
|
|
// Starlight's own light/dark switch is deliberate: §11 keeps marketing single-theme
|
|
// but has the docs honour the reader's preference.
|
|
customCss: ['./src/styles/tokens.css', './src/styles/starlight.css'],
|
|
components: {
|
|
// Not the `logo` option: that takes an asset imported through Vite, which
|
|
// fingerprints the filename into the build — and a fingerprinted logo is one the
|
|
// bind mount can never replace (§7). The override points at the stable
|
|
// `/brand/*` URL instead.
|
|
SiteTitle: './src/components/DocsSiteTitle.astro',
|
|
// Starlight builds its own head, so the docs otherwise miss the brand stylesheet,
|
|
// the manifest and the OG card entirely. See the component.
|
|
Head: './src/components/DocsHead.astro',
|
|
},
|
|
credits: false,
|
|
sidebar: docsSidebar,
|
|
pagination: true,
|
|
lastUpdated: false,
|
|
editLink: {
|
|
baseUrl: 'https://gitea.whitlocktech.com/RunicGateway/runicgateway.com/_edit/main/',
|
|
},
|
|
}),
|
|
],
|
|
|
|
prefetch: {
|
|
prefetchAll: true,
|
|
defaultStrategy: 'hover',
|
|
},
|
|
});
|