Add per-site READMEs describing what each site serves

Covers pages, data sources, config knobs, files and deploy target for 40k-rankings, aos-rankings, events, kingmaker and scouting. Also lists events in the root README layout and points to the per-site docs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-22 16:46:40 -05:00
parent 7883ecca90
commit 95a54e9ec2
6 changed files with 358 additions and 4 deletions
@@ -0,0 +1,51 @@
+# kingmaker.gateway-gamers.net
+
+The hub for Kingmaker, a local Warhammer 40k league campaign split into
+divisions by skill level. The site is a thin shell around Google Forms and a
+Google Sheet; it has no data or logic of its own.
+
+## What it serves
+
+| Page | Contents |
+| --- | --- |
+| `index.html` | Campaign home: current season and dates, sign-up status, how divisions work, quick links |
+| `signups.html` | Embedded Google Form for joining, plus a note about paying the entry fee at Game Nite |
+| `reporting.html` | Embedded Google Form for reporting game results |
+| `standings.html` | Embedded published Google Sheet with campaign standings |
+
+Each page is a separate Vite entry point, listed under `build.rollupOptions.input`
+in `vite.config.js`.
+
+## Data sources
+
+Everything is in Google, owned by the league organizer:
+
+- Sign-ups and game reports go into their Google Forms' response sheets.
+- Standings are a published-to-web tab of a Google Sheet.
+
+To change a form or the standings, edit it in Google. To point the site at a
+different form or sheet, replace the iframe `src` in the relevant HTML file.
+
+## Updating each season
+
+Season name, dates and sign-up status are hardcoded in `index.html`. The entry
+fee note is in `signups.html`. There's also a commented-out PayPal block there
+that can be re-enabled if fees move back to PayPal.
+
+## Files
+
+- `index.html`, `signups.html`, `reporting.html`, `standings.html`: the pages
+- `src/main.js`: loads the shared header and footer only
+- `src/style.css`: Tailwind and daisyUI entry
+- `nav.html`: this site's header nav entries (see the root README)
+- `kingmaker.gateway-gamers.net.conf`: reference nginx config for the live
+  server block. It sets a Content-Security-Policy, so embedding anything from a
+  new host means adding it to `frame-src` there too.
+- `CLAUDE.md`: notes for Claude Code on the Vite, Tailwind and daisyUI setup
+
+## Deploy
+
+`.gitea/workflows/deploy-kingmaker.yml` builds the site and rsyncs `dist/` to
+`/var/www/domains/gateway-gamers.net/kingmaker/` on every push to `main` that
+touches `sites/kingmaker/` or `shared/`. See the root README for local dev
+commands and the shared header, footer and images.