feat(docs): phase 15 — the Rust group, its reference pages checked against their sources #35

wtclaude · 2026-10-22T15:23:32-05:00

wtclaude commented

2026-10-22 15:23:32 -05:00

Phase 15 of PLAN.md §16: the Rust docs group, after Ultima Online. RunicNPC's subgroup is phase 16.

The group: 15 pages (D70)

You chose the option I labelled "14 pages", but its own list had fifteen entries. The list is what's built, and PLAN.md records the mislabel.

Kind	Pages
Overview	The Rust module
Journey	Install the bridge (installer · Pterodactyl egg · by hand) · Connect the site · Verify the bridge
One per admin screen	Permissions and groups · Mod config from the site · Who sees who is online · Events, zones and rewards
Topics	Linking Steam accounts · Optional plugins (RaidableBases restart-not-reload, Guarded Crate + NpcSpawn) · The live map · Troubleshooting
Reference	sidecar.toml · RunicGateway.json · Event kinds

Every page teaches and then links out to its canonical document. Versions come from platform.json, including the protocol inside code samples, which are rendered with Starlight's <Code>.

Checks: three new sections in `checkReference.mjs` (no new check)

rust-link sidecar.toml: 6 keys from Rust-Link config.rs, using the same struct parser as uo-link's (now shared), plus the 6 RUSTLINK_… env overrides.
RunicGateway.json: the 13 public fields of PluginConfig in RunicGateway.cs.
Event kinds (D71): public, presence and staff, compared separately against Module-Rust server/catalogue.js. A kind that moves from staff to public upstream fails twice.

The canonical documents gain OPERATING.md and CARBON.md under Rust.

Walked first (D36)

I signed in on the walk site and walked:

Rust servers: Test, Edit, Chat titles and Optional mods;
Rust permissions: a player, and a group's four tabs;
Rust mod config, including RunicGateway.json's read-only keys;
Rust visibility;
Rust zone presets;
the event editor's action list;
a user's Rust section;
the public server page: its feed, map and leaderboard.

Nothing was saved, and there were no console errors. The walk and the source corrected three of my drafts: a reward does not need a linked account, the bundle ships three helpers, and the Test button prints raw statuses.

Core pages

Re-pointed to the Rust group: Connect your game server, Requirements, Verify the whole stack, Install a game module, Troubleshooting, the docs index, The bridge and Installer CLI (all previously linked out to the docs repo or said "Ultima Online today").
Fixed, found in the re-read:
- The UO Verify the bridge /health sample hard-coded "protocol":4. It now reads platform.json (8).
- Authentication said "four tabs" and never mentioned Steam. It now has five tabs and a Steam section.
- Scheduled events and Events architecture said the site cannot reach EventsEnabled. That's false on Rust: Mod config can edit RunicGateway.json. Both pages now say so (D68 tagged examples on the first).
checkFacts went red mid-phase: installer v0.8.1 shipped (the --help fix). platform.json is updated; no page quotes the help text.

Found in other repositories (reported, not fixed)

Module-Rust admin copy shows decision numbers: the group Servers tab says "(D189)", and the not imported yet chip's tooltip says "(D198)".
Module-Rust servers page: "Last pushed: 1 player hold one." (should be "holds").
Rust-Plugins: the comment on PluginConfig.EventsEnabled says it "gates taking a lease only". That stopped being true at protocol 9.
docs rust-link/INTEGRATION.md + INSTALL.md: fixed in docs#370, the separate PR you approved.

If you want the three Module-Rust / Rust-Plugins items fixed, say so and I'll do them.

Decisions recorded (count of record 71)

D70: the page list above.
D71: check the kinds against the module's classification, not PROTOCOL.md's tables.

Verification

npm run verify is green locally:

all 12 checks;
checkReference now runs 36 checks;
checkLinks resolves 5319 internal links;
42 + 8 tests pass;
a11y and CSP pass on 74 pages.

I also opened two rendered pages in Chrome.

AI-assisted: Claude Code (Claude Opus 5.5)

🤖 Generated with Claude Code

https://claude.ai/code/session_01E14m6SuuY6i1vASFeGDBeY

Phase 15 of PLAN.md §16: the Rust docs group, after Ultima Online. RunicNPC's subgroup is phase 16. ## The group: 15 pages (D70) You chose the option I labelled "14 pages", but its own list had fifteen entries. The list is what's built, and PLAN.md records the mislabel. | Kind | Pages | |---|---| | Overview | The Rust module | | Journey | Install the bridge (installer · Pterodactyl egg · by hand) · Connect the site · Verify the bridge | | One per admin screen | Permissions and groups · Mod config from the site · Who sees who is online · Events, zones and rewards | | Topics | Linking Steam accounts · Optional plugins (RaidableBases restart-not-reload, Guarded Crate + NpcSpawn) · The live map · Troubleshooting | | Reference | sidecar.toml · RunicGateway.json · Event kinds | Every page teaches and then links out to its canonical document. Versions come from `platform.json`, including the protocol inside code samples, which are rendered with Starlight's `<Code>`. ## Checks: three new sections in `checkReference.mjs` (no new check) - **rust-link `sidecar.toml`**: 6 keys from `Rust-Link` `config.rs`, using the same struct parser as uo-link's (now shared), plus the 6 `RUSTLINK_…` env overrides. - **`RunicGateway.json`**: the 13 public fields of `PluginConfig` in `RunicGateway.cs`. - **Event kinds (D71)**: public, presence and staff, compared separately against `Module-Rust` `server/catalogue.js`. A kind that moves from staff to public upstream fails twice. The canonical documents gain `OPERATING.md` and `CARBON.md` under Rust. ## Walked first (D36) I signed in on the walk site and walked: - Rust servers: Test, Edit, Chat titles and Optional mods; - Rust permissions: a player, and a group's four tabs; - Rust mod config, including `RunicGateway.json`'s read-only keys; - Rust visibility; - Rust zone presets; - the event editor's action list; - a user's Rust section; - the public server page: its feed, map and leaderboard. Nothing was saved, and there were no console errors. The walk and the source corrected three of my drafts: a reward does **not** need a linked account, the bundle ships **three** helpers, and the Test button prints raw statuses. ## Core pages - **Re-pointed to the Rust group:** *Connect your game server*, *Requirements*, *Verify the whole stack*, *Install a game module*, Troubleshooting, the docs index, *The bridge* and *Installer CLI* (all previously linked out to the docs repo or said "Ultima Online today"). - **Fixed, found in the re-read:** - The UO *Verify the bridge* `/health` sample hard-coded `"protocol":4`. It now reads `platform.json` (8). - *Authentication* said "four tabs" and never mentioned Steam. It now has five tabs and a Steam section. - *Scheduled events* and *Events architecture* said the site cannot reach `EventsEnabled`. That's false on Rust: Mod config can edit `RunicGateway.json`. Both pages now say so (D68 tagged examples on the first). - **`checkFacts` went red mid-phase:** installer **v0.8.1** shipped (the `--help` fix). `platform.json` is updated; no page quotes the help text. ## Found in other repositories (reported, not fixed) - **Module-Rust admin copy shows decision numbers:** the group *Servers* tab says "(D189)", and the *not imported yet* chip's tooltip says "(D198)". - **Module-Rust servers page:** "Last pushed: 1 player hold one." (should be "holds"). - **Rust-Plugins:** the comment on `PluginConfig.EventsEnabled` says it "gates taking a lease only". That stopped being true at protocol 9. - **docs `rust-link/INTEGRATION.md` + `INSTALL.md`:** fixed in **docs#370**, the separate PR you approved. If you want the three Module-Rust / Rust-Plugins items fixed, say so and I'll do them. ## Decisions recorded (count of record 71) - **D70**: the page list above. - **D71**: check the kinds against the module's classification, not PROTOCOL.md's tables. ## Verification `npm run verify` is green locally: - all 12 checks; - `checkReference` now runs 36 checks; - `checkLinks` resolves 5319 internal links; - 42 + 8 tests pass; - a11y and CSP pass on 74 pages. I also opened two rendered pages in Chrome. - [x] AI-assisted: Claude Code (Claude Opus 5.5) 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_01E14m6SuuY6i1vASFeGDBeY

wtclaude added 1 commit 2026-10-22 15:23:34 -05:00

feat(docs): phase 15 - the Rust group, its reference pages checked against their sources

PR checks / checks (pull_request) Successful in 2m5s

Details

75c8ffc07a

PLAN.md §16 phase 15. A Rust group of fifteen pages after Ultima Online
(D70): the module, installing the bridge (installer, Pterodactyl egg, by
hand), connecting the site, verifying the bridge, linking Steam accounts,
permissions and groups, mod config, who sees who is online, events, zones
and rewards, optional plugins, the live map, troubleshooting, and three
reference pages - rust-link's sidecar.toml, the plugin's
RunicGateway.json, and the event kinds.

checkReference.mjs gains three Rust sections rather than a new check:
sidecar.toml keys and RUSTLINK_* overrides from Rust-Link config.rs,
RunicGateway.json from the plugin's PluginConfig, and the event kinds
in three classes against Module-Rust server/catalogue.js (D71). Every
admin screen was walked on the walk site before it was described (D36).

Core pages now hand off to the Rust group instead of linking out to the
docs repository. Three defects the re-read found here are fixed: the UO
/health sample's hard-coded protocol 4 (both games' samples now render
platform.json through <Code>), Authentication's missing Steam tab, and
two pages saying the site cannot reach EventsEnabled - false on Rust.

Installer v0.8.1 moved checkFacts red mid-phase; platform.json follows.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01E14m6SuuY6i1vASFeGDBeY

whitlocktech merged commit aad3a37c09 into main

2026-10-22 15:26:33 -05:00

whitlocktech referenced this issue from a commit

2026-10-22 15:26:34 -05:00

Merge pull request 'feat(docs): phase 15 — the Rust group, its reference pages checked against their sources' (#35) from feat/phase-15-rust into main

whitlocktech deleted branch feat/phase-15-rust

2026-10-22 15:26:34 -05:00

wtclaude referenced this pull request

2026-10-22 15:31:55 -05:00

docs(plan): phase 15's other-repository findings are fixed #36

Sign in to join this conversation.