Commit Graph

52 Commits

Author SHA1 Message Date
96f77a87e1 docs(plan): the design of record for runicgateway.com
Reconnaissance across the nine RunicGateway checkouts, and the plan for the
public site + documentation experience built on top of them.

The site is a presentation layer over existing project knowledge: normative
contracts stay canonical in docs/ and are linked, never copied. What the site
authors is the journey — install, configure, administer, extend — which no
existing document owns end to end, because the repos are organised by
component and an operator is not.

Two things worth reading before the rest:

- Section 3 lists eleven places the repositories contradict each other,
  verified against origin/main rather than resolved quietly. The sharpest is
  that link/INTEGRATION.md documents the protocol-4 event kinds while its
  normative section 2 still declares X-UOLink-Version: 3 — one document
  disagreeing with itself. installer/INSTALL.md still hands operators
  "Protocol version 3", which is the value they paste into Admin -> Shard,
  and its own troubleshooting table says a stale number looks exactly like
  the shard going offline.

- Section 4 makes fixing those a Phase 0 that lands before the site quotes
  anything: four PRs across docs and .profile, none of which touch code or a
  contract. They correct documentation to match what main already does.

Section 1 also records a process failure and the rule taken from it. An
earlier draft claimed the platform was on protocol 3 with 4 "not cut over".
Every checkout was on a feature branch whose local main ref had never been
fetched, so git show main:<path> answered from a months-old blob. Every fact
in section 2 is now read from origin/main or the Gitea API, and section 7
turns that into a build-time check instead of a promise.

Section 9 leaves five questions open rather than assuming answers.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-08-19 15:07:30 -05:00
f79c938e12 Initial commit 2026-08-19 19:55:15 +00:00