All checks were successful
PR checks / checks (pull_request) Successful in 1m41s
The last leg of the Asset Bridge (docs/link/v8.md §16, phase 9c). The cutover put protocol 8 on `main` in every declaration site, which turned this repo red by construction: `checkFacts.mjs` reads the protocol from `link`'s `main`. Two checks were failing, and only one of them was expected. **checkFacts (10)** — protocol 7 → 8 in all three reads (sidecar, overlay, bundle), the bundle triple to 2026.09.15 / sidecar v2.3.0 / overlay v1.3.0, and the releases to link v2.3.0, installer v0.2.0, Module-uo v1.3.0. `moduleApi` and the capability list did not move: core's whole share of eight phases was a deletion. **checkReference (9)** — nobody had planned for this one. `Bridge.cfg` grew nine keys across phases 5, 6 and 7 and the reference page had gone on not mentioning them, which is the failure mode that check exists for. They are listed as two new groups, `Client assets` and `Spawn files`, because they are two separate consents. ## The prose the bridge changed - **New page, Administration → Client files.** `Admin → Client files` is a screen an operator has to press a button on and the site had no page for it. It carries the rule nothing else states: **nothing here happens on a restart**, so a patched client keeps serving the old artwork until somebody says so. - **Protocol versions** said the most recent bump touched five repositories and named `website`. Protocol 8 touched four and did not reach core — its absence is the interesting half, and the page now says why. The store-migration paragraph gains 8, which changed no line of the sidecar's store despite moving megabytes. - **The bridge** said "two ways in". There are three: bulk reads go over the request/reply path in pages, one in flight at a time, and the reason they must not ride the event stream is structural rather than about speed. - **Requirements** gains `libgdiplus` for Linux shard hosts, and the note that no game client has to be installed for any of this — a ServUO shard cannot boot without one. - **Troubleshooting** gains the failure mode that did not exist before: a bestiary with no pictures, or items reading as numbers. - **Maintenance** gains the button to press after patching a client, and **Verify the whole stack** the `doctor` check that landed with it. - The spawn atlas and the marketplace both carry artwork now, so both capability descriptions say so, and `canonicalDocs` points at `link/v8.md`. ## Screenshots, retaken against the real thing The atlas and marketplace shots predate the asset plane, so both were retaken on the demo deployment against a real shard and a real sidecar, plus the new admin screen: 1,095 portraits imported in 2.1 s, 67,496 names in 1.4 s, 313 item pictures in 0.8 s. Nothing here is a mock-up. The atlas shot moved 36px down its page because portraits made the rows taller. ## One defect found on the way `seedDemo.mjs` pinned the demo deployment at **protocol 4** with a comment explaining a `module-uo` debt that has since been paid. Its default now comes from `platform.json`, so the rig cannot drift two protocols behind the platform again. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016wDDVXWMDz82WqE1i969r4
158 lines
6.4 KiB
JavaScript
158 lines
6.4 KiB
JavaScript
/**
|
|
* The documentation sidebar — PLAN.md §10 "Documentation", five groups, ~37 pages.
|
|
*
|
|
* The pages themselves land in phases 7 and 8. This file exists in phase 1 because the
|
|
* shape of the journey is a design decision that is already made, and because a sidebar
|
|
* written up front is what stops the docs from being organised by repository. A reader
|
|
* should never need to know that `link`, `servuo-plugins` and `installer` are three
|
|
* repositories in order to connect a game server (§10).
|
|
*
|
|
* `autogenerate` is deliberately NOT used: the order of "Getting started" is the
|
|
* installation path from §10, and alphabetical order would scramble it.
|
|
*
|
|
* Entries are added as their pages are written — Starlight fails the build on a link to a
|
|
* page that does not exist, which is the behaviour we want.
|
|
*/
|
|
export const docsSidebar = [
|
|
{
|
|
label: 'Getting started',
|
|
items: [
|
|
{ label: 'What is Runic Gateway?', slug: 'docs' },
|
|
{ label: 'Requirements', slug: 'docs/getting-started/requirements' },
|
|
{ label: 'Install the site', slug: 'docs/getting-started/install-the-site' },
|
|
{ label: 'First run', slug: 'docs/getting-started/first-run' },
|
|
{ label: 'Install a game module', slug: 'docs/getting-started/install-a-game-module' },
|
|
{ label: 'Connect a game server', slug: 'docs/getting-started/connect-a-game-server' },
|
|
{ label: 'Verify the whole stack', slug: 'docs/getting-started/verify-the-whole-stack' },
|
|
],
|
|
},
|
|
{
|
|
label: 'Administration',
|
|
items: [
|
|
{ label: 'Configuration', slug: 'docs/administration/configuration' },
|
|
{ label: 'Branding and theming', slug: 'docs/administration/branding-and-theming' },
|
|
{ label: 'Navigation and pages', slug: 'docs/administration/navigation-and-pages' },
|
|
{ label: 'Content', slug: 'docs/administration/content' },
|
|
{ label: 'Users and roles', slug: 'docs/administration/users-and-roles' },
|
|
{ label: 'Authentication', slug: 'docs/administration/authentication' },
|
|
{ label: 'Teams', slug: 'docs/administration/teams' },
|
|
{ label: 'Scheduled events', slug: 'docs/administration/events' },
|
|
{ label: 'Moderation', slug: 'docs/administration/moderation' },
|
|
{ label: 'Notifications and email', slug: 'docs/administration/notifications-and-email' },
|
|
{ label: 'Engagement rules', slug: 'docs/administration/engagement-rules' },
|
|
{ label: 'Message templates', slug: 'docs/administration/message-templates' },
|
|
{ label: 'Managing modules', slug: 'docs/administration/managing-modules' },
|
|
{ label: 'The shard connection', slug: 'docs/administration/the-shard-connection' },
|
|
{ label: 'Client files', slug: 'docs/administration/client-files' },
|
|
{ label: 'Maintenance and upgrades', slug: 'docs/administration/maintenance-and-upgrades' },
|
|
{ label: 'Troubleshooting', slug: 'docs/administration/troubleshooting' },
|
|
],
|
|
},
|
|
{
|
|
label: 'Modules',
|
|
items: [
|
|
{ label: 'The module system', slug: 'docs/modules/the-module-system' },
|
|
{ label: 'Installing modules', slug: 'docs/modules/installing-modules' },
|
|
{ label: 'Module lifecycle', slug: 'docs/modules/module-lifecycle' },
|
|
{ label: 'The module manifest', slug: 'docs/modules/the-module-manifest' },
|
|
{ label: 'The module API', slug: 'docs/modules/the-module-api' },
|
|
{ label: 'Building a module', slug: 'docs/modules/building-a-module' },
|
|
{ label: 'The Integration Kit', slug: 'docs/modules/the-integration-kit' },
|
|
{ label: 'Testing and release', slug: 'docs/modules/testing-and-release' },
|
|
],
|
|
},
|
|
{
|
|
label: 'Architecture',
|
|
items: [
|
|
{ label: 'System architecture', slug: 'docs/architecture/system-architecture' },
|
|
{ label: 'The bridge', slug: 'docs/architecture/the-bridge' },
|
|
{ label: 'Authentication architecture', slug: 'docs/architecture/authentication-architecture' },
|
|
{ label: 'Teams architecture', slug: 'docs/architecture/teams-architecture' },
|
|
{ label: 'Events architecture', slug: 'docs/architecture/events-architecture' },
|
|
{ label: 'Protocol versions', slug: 'docs/architecture/protocol-versions' },
|
|
],
|
|
},
|
|
{
|
|
label: 'Reference',
|
|
items: [
|
|
{ label: 'Environment variables', slug: 'docs/reference/environment-variables' },
|
|
{ label: 'Installer CLI', slug: 'docs/reference/installer-cli' },
|
|
{ label: 'sidecar.toml', slug: 'docs/reference/sidecar-toml' },
|
|
{ label: 'Bridge.cfg', slug: 'docs/reference/bridge-cfg' },
|
|
{ label: 'HTTP API', slug: 'docs/reference/http-api' },
|
|
{ label: 'Shard event catalog', slug: 'docs/reference/event-catalog' },
|
|
{ label: 'Canonical documents', slug: 'docs/reference/canonical-documents' },
|
|
],
|
|
},
|
|
];
|
|
|
|
/**
|
|
* The tree §10 planned, kept as the record of what was intended — every page it names now
|
|
* exists, as of phase 8.
|
|
*
|
|
* It was the phases 7/8 checklist, and a checklist with nothing left on it is no longer
|
|
* pulling its weight: it is a second copy of the tree above, maintained by hand, and it had
|
|
* already drifted once (phase 7 added `Content` under D37 and this list was not updated,
|
|
* which nothing caught because nothing reads it). `checkSidebar.mjs` now asserts the two
|
|
* agree, which is what makes keeping it safe.
|
|
*
|
|
* Not exported into the Starlight config.
|
|
*/
|
|
export const plannedSidebar = {
|
|
'Getting started': [
|
|
'What is Runic Gateway?',
|
|
'Requirements',
|
|
'Install the site',
|
|
'First run',
|
|
'Install a game module',
|
|
'Connect a game server',
|
|
'Verify the whole stack',
|
|
],
|
|
Administration: [
|
|
'Configuration',
|
|
'Branding and theming',
|
|
'Navigation and pages',
|
|
'Content',
|
|
'Users and roles',
|
|
'Authentication',
|
|
'Teams',
|
|
'Scheduled events',
|
|
'Moderation',
|
|
'Notifications and email',
|
|
'Engagement rules',
|
|
'Message templates',
|
|
'Managing modules',
|
|
'The shard connection',
|
|
'Client files',
|
|
'Maintenance and upgrades',
|
|
'Troubleshooting',
|
|
],
|
|
Modules: [
|
|
'The module system',
|
|
'Installing modules',
|
|
'Module lifecycle',
|
|
'The module manifest',
|
|
'The module API',
|
|
'Building a module',
|
|
'The Integration Kit',
|
|
'Testing and release',
|
|
],
|
|
Architecture: [
|
|
'System architecture',
|
|
'The bridge',
|
|
'Authentication architecture',
|
|
'Teams architecture',
|
|
'Events architecture',
|
|
'Protocol versions',
|
|
],
|
|
Reference: [
|
|
'Environment variables',
|
|
'Installer CLI',
|
|
'sidecar.toml',
|
|
'Bridge.cfg',
|
|
'HTTP API',
|
|
'Shard event catalog',
|
|
'Canonical documents',
|
|
],
|
|
};
|