/** * 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' }], }, ]; /** * The full planned tree, kept next to the live sidebar so phases 7 and 8 have their * checklist in the place they will be working. Not exported into the Starlight config — * it names pages that do not exist yet. */ 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', 'Users and roles', 'Authentication', 'Teams', 'Moderation', 'Notifications and email', 'Managing modules', 'The shard connection', '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', 'Protocol versions', ], Reference: [ 'Environment variables', 'Installer CLI', 'sidecar.toml', 'Bridge.cfg', 'HTTP API', 'Event catalog', 'Canonical documents', ], };