Clean up README and organize documentation

2026-10-06 23:51:41 -04:00
parent 75b6a0a783
commit 8fcabe27fc
38 changed files with 687 additions and 1249 deletions
@@ -0,0 +1,51 @@
+# Documentation
+
+Start with [Getting started](guides/getting-started.md) to set up a controller
+and launch your first server.
+
+## Guides
+
+### Setup and administration
+
+- [Getting started](guides/getting-started.md) — requirements, installation, and first launch.
+- [Native hosts](guides/native-hosts.md) — enrollment, game files, capacity, agent updates, and recovery.
+- [Users and access](guides/authentication.md) — roles, sessions, telemetry credentials, and password recovery.
+- [Fleet settings](guides/settings.md) — concurrency, retention, and cleanup.
+
+### Fleet operations
+
+- [Provisioning](guides/provisioning.md) — lifecycle actions, safety checks, queues, and diagnostics.
+- [Collections](guides/collections.md) — reusable map lineups and promoted launch files.
+- [Lobby autoscaling](guides/autoscaling.md) — policies, ownership, pause controls, and the pilot procedure.
+- [Maintenance](guides/maintenance.md) — health recovery, drift repair, updates, and scheduled restarts.
+
+### Releases and analytics
+
+- [Beta test plans](guides/beta-test-plans.md) — game reporters, test requirements, coverage, and outcomes.
+- [Plugin releases](guides/plugin-releases.md) — GitHub release discovery and imports.
+- [Metrics](guides/metrics.md) — utilization, capacity pressure, and hosting experiments.
+- [Leaderboard and matches](guides/leaderboard.md) — player statistics, match history, and the read API.
+
+## Development
+
+- [Development guide](development/README.md) — local setup, architecture, checks, and database diagnostics.
+- [UI patterns](development/ui-patterns.md) — shared components, forms, navigation, and refresh behavior.
+
+## Plans
+
+[Lobby autoscaling](plans/lobby-autoscaling-plan.md) records the implemented design
+and the production dry run, pilot measurements, and rollout still to complete.
+Current operating instructions live in the guides above.
+
+## Research
+
+- [Reducing idle CPU use](research/t5-t6-idle-cpu-research.md) — runtime tuning and lobby availability experiments.
+- [Leaderboard query benchmark](research/leaderboard-query-benchmark.md) — historical SQL measurements and methodology.
+
+Research records its baseline and measurement limits; consult the guides for
+current behavior.
+
+Keep operating instructions in `guides/`, contributor guidance in `development/`,
+unfinished delivery or rollout work in `plans/`, and investigations in `research/`.
+When a plan is complete, fold its lasting guidance into the relevant guide and
+remove the superseded document. Git history preserves earlier reviews and plans.