56 lines
2.7 KiB
Markdown
56 lines
2.7 KiB
Markdown
# 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
|
|
|
|
[Player achievements and visual refresh](plans/player-achievements-and-visual-refresh-plan.md)
|
|
proposes calendar leaderboards, personal-best highlights, shareable result cards,
|
|
and consistent map and status presentation.
|
|
|
|
[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.
|