docs: bring the org profile up to current state #1

wtclaude · 2026-08-07T21:38:58Z

wtclaude commented

2026-08-07 21:38:58 +00:00

What & why

This README is the org landing page — the first thing anyone sees at gitea.whitlocktech.com/RunicGateway. It was last touched 2026-07-23, which is before the installer repo existed (created 2026-08-04, released v0.1.0 on 2026-08-07).

The worst of it was Quick start: it told a new shard operator to git clone the sidecar, cargo build --release, hand-edit sidecar.toml, and then go read another repo for plugin deploy steps. That is now the development path, not the setup path.

Six repositories, not five — installer added to the table.
Quick start steps 2 and 3 collapse into one installer run. Download + verify + install, what it resolves (a protocol-checked bundle, not "latest of each"), and the four values it prints for Admin → Shard. The by-hand path is kept as a note pointing at Appendix A — supported, not the default.
Day-two commands, plus the note that the installer does not install itself, so nobody goes looking for runicgateway on PATH. (INSTALL.md shortens the name in its examples; without that context a bare runicgateway doctor here would mislead.)
What shipped since July now appears: the player-vendor marketplace, the spawn atlas/bestiary, the admin-configurable shard visibility framework, and the account-security layer — TOTP with trusted devices, link-only SSO, bot scoring with automatic IP bans.
"Where to go next" leads with INSTALL.md; the link/servuo-plugins entry is reframed as working on them rather than deploying them.

Companion to the installer-first docs pass: docs#102, installer#19, link#30, servuo-plugins#11, website#120.

How it was tested

Docs-only, but the claims were checked rather than carried forward:

JDK 17 and min SDK 29 still match android-app/app/build.gradle.kts (JavaVersion.VERSION_17, jvmTarget = "17", minSdk = 29) — I nearly "corrected" the JDK and was wrong to.
Node 20+ still matches the website README and its FROM node:20-alpine.
Every npm script named (install-server, install-client, server, client) exists in the website root package.json.
Marketplace, spawn atlas, shard visibility and appeals confirmed as real shipped routes in website/client/src/routes/**, not plans.
Installer asset names and the download flow match the published v0.1.0 release.

Checklist

I have read CONTRIBUTING.md.
The change builds and existing tests/checks pass locally.
I have added or updated tests/docs where it makes sense.
My commits are reasonably scoped with clear messages.

AI-assisted contributions (required)

AI tools were used. Tool(s): Claude Code. I have reviewed and understand every change, and take responsibility for it. AI-authored commits are marked with a Co-Authored-By trailer.

License

I agree that my contribution is licensed under this project's license (GNU GPL v3.0 or later), and I have the right to contribute it.

## What & why This README is the **org landing page** — the first thing anyone sees at `gitea.whitlocktech.com/RunicGateway`. It was last touched 2026-07-23, which is *before the installer repo existed* (created 2026-08-04, released [v0.1.0](https://gitea.whitlocktech.com/RunicGateway/installer/releases/tag/v0.1.0) on 2026-08-07). The worst of it was Quick start: it told a new shard operator to `git clone` the sidecar, `cargo build --release`, hand-edit `sidecar.toml`, and then go read another repo for plugin deploy steps. That is now the *development* path, not the setup path. - **Six repositories, not five** — `installer` added to the table. - **Quick start steps 2 and 3 collapse into one installer run.** Download + verify + `install`, what it resolves (a protocol-checked bundle, not "latest of each"), and the four values it prints for Admin → Shard. The by-hand path is kept as a note pointing at Appendix A — supported, not the default. - **Day-two commands**, plus the note that the installer *does not install itself*, so nobody goes looking for `runicgateway` on `PATH`. (INSTALL.md shortens the name in its examples; without that context a bare `runicgateway doctor` here would mislead.) - **What shipped since July** now appears: the player-vendor marketplace, the spawn atlas/bestiary, the admin-configurable shard visibility framework, and the account-security layer — TOTP with trusted devices, link-only SSO, bot scoring with automatic IP bans. - **"Where to go next"** leads with INSTALL.md; the link/servuo-plugins entry is reframed as *working on* them rather than *deploying* them. Companion to the installer-first docs pass: docs#102, installer#19, link#30, servuo-plugins#11, website#120. ## How it was tested Docs-only, but the claims were checked rather than carried forward: - **JDK 17** and **min SDK 29** still match `android-app/app/build.gradle.kts` (`JavaVersion.VERSION_17`, `jvmTarget = "17"`, `minSdk = 29`) — I nearly "corrected" the JDK and was wrong to. - **Node 20+** still matches the website README and its `FROM node:20-alpine`. - Every npm script named (`install-server`, `install-client`, `server`, `client`) exists in the website root `package.json`. - Marketplace, spawn atlas, shard visibility and appeals confirmed as real shipped routes in `website/client/src/routes/**`, not plans. - Installer asset names and the download flow match the published v0.1.0 release. ## Checklist - [x] I have read [CONTRIBUTING.md](CONTRIBUTING.md). - [x] The change builds and existing tests/checks pass locally. - [x] I have added or updated tests/docs where it makes sense. - [x] My commits are reasonably scoped with clear messages. ## AI-assisted contributions (required) - [x] AI tools were used. Tool(s): `Claude Code`. I have reviewed and understand every change, and take responsibility for it. AI-authored commits are marked with a `Co-Authored-By` trailer. ## License - [x] I agree that my contribution is licensed under this project's license (**GNU GPL v3.0 or later**), and I have the right to contribute it.

wtclaude added 1 commit 2026-08-07 21:38:59 +00:00

docs: bring the org profile up to current state f98005eec0

Last touched 2026-07-23, before the installer repo existed.

- Six repos, not five: add installer to the table.
- Quick start: steps 2 (cargo build the sidecar) and 3 (see the plugin
  repo for deploy steps) collapse into one installer run, which is how a
  shard is actually set up now. The by-hand path is kept as a note.
- Day-two commands and the note that the installer does not install
  itself, so nobody looks for `runicgateway` on PATH.
- Mention what shipped since: the player-vendor marketplace, the spawn
  atlas, the admin-configurable shard visibility framework, and the
  account-security layer (TOTP + trusted devices, link-only SSO, bot
  scoring).
- "Where to go next" leads with INSTALL.md; the link and servuo-plugins
  entry is now about working on them rather than deploying them.

Verified rather than assumed: JDK 17 and min SDK 29 still match
app/build.gradle.kts, and Node 20+ still matches the website README and
its Dockerfile.

Co-Authored-By: Claude <noreply@anthropic.com>

whitlocktech merged commit f7bd697bfa into main

2026-08-07 21:40:40 +00:00

whitlocktech deleted branch docs/installer-first-setup

2026-08-07 21:40:41 +00:00

whitlocktech referenced this issue from a commit

2026-08-07 21:40:41 +00:00

Merge pull request 'docs: bring the org profile up to current state' (#1) from docs/installer-first-setup into main

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: RunicGateway/.profile#1