|
| 1 | += Game Server Admin — Documentation Index |
| 2 | +:revdate: 2026-06-21 |
| 3 | + |
| 4 | +Audience-segmented map of the GSA documentation. Start here, then pick your role. |
| 5 | + |
| 6 | +[NOTE] |
| 7 | +==== |
| 8 | +Status legend: *live* = written and current; *thin* = exists but covers only |
| 9 | +setup/basic-run; *planned* = a known gap, scoped below, tracked for the v1.0.0 |
| 10 | +documentation pass. See `ROADMAP.adoc` for release gates and `.claude/CLAUDE.md` |
| 11 | +for the codebase quick-context. |
| 12 | +==== |
| 13 | + |
| 14 | +== End users |
| 15 | +_You run and administer game servers via the Gossamer GUI and the `gsa` CLI._ |
| 16 | + |
| 17 | +[cols="2,1,4"] |
| 18 | +|=== |
| 19 | +| Document | Status | Covers |
| 20 | + |
| 21 | +| `README.adoc` | live | Overview, quick-start, `gsa` CLI reference, supported games |
| 22 | +| `USER-CONFIG.md` | live | Nickel config: defaults, favourites, troubleshooting |
| 23 | +| `docs/QUICKSTART.adoc` | thin | One-liner pointer — not a real getting-started |
| 24 | +| GUI panel guide | *planned* | One section per panel (8: server-browser, config-editor, server-actions, live-logs, health-dashboard, config-history, cross-search, nexus-setup). **`nexus-setup`, the 7-step provisioning wizard, is entirely undocumented.** |
| 25 | +| Game-profile selection | *planned* | Which game → which of the 18 profiles; port/protocol table |
| 26 | +| Admin workflows | *planned* | Add a server; manage config across servers; roll back via config history |
| 27 | +|=== |
| 28 | + |
| 29 | +== Developers |
| 30 | +_You build GSA, extend it, or contribute code across the Gossamer GUI → Zig FFI → Idris2 ABI → VeriSimDB stack._ |
| 31 | + |
| 32 | +[cols="2,1,4"] |
| 33 | +|=== |
| 34 | +| Document | Status | Covers |
| 35 | + |
| 36 | +| `README.adoc` | live | Architecture diagram, module map, "Adding a Game Profile" snippet |
| 37 | +| `docs/developer/ABI-FFI-README.adoc` | live | Idris2 ABI + Zig FFI standard; C/Idris2/Rust/Julia examples (strong) |
| 38 | +| `TOPOLOGY.md` | live | System architecture + data flow |
| 39 | +| `docs/decisions/` | live | Architecture decision records (RSR adoption) |
| 40 | +| FFI module reference | *planned* | Per-module docs for the 11 FFI modules (signatures, the 13 result codes, examples) |
| 41 | +| Panel extension guide | *planned* | The PanLL clade system; registering a new panel; inheriting base clades |
| 42 | +| Game-profile authoring | *thin* | Expand the README snippet: field types, validation, port/protocol, debugging |
| 43 | +| Config-format guide | *planned* | How to add a parser to the 8-format `config_extract` |
| 44 | +| Architecture rationale | *planned* | Why Ephapax / Idris2 / Zig / VeriSimDB; when to touch each layer |
| 45 | +|=== |
| 46 | + |
| 47 | +== Maintainers |
| 48 | +_You release, run CI/CD, operate containers, and manage governance + security scanning._ |
| 49 | + |
| 50 | +[cols="2,1,4"] |
| 51 | +|=== |
| 52 | +| Document | Status | Covers |
| 53 | + |
| 54 | +| `docs/governance/MAINTENANCE-CHECKLIST.adoc` | live | Three-axis model, hygiene, ABI purity, panic-attack (strong) |
| 55 | +| `docs/architecture/THREAT-MODEL.adoc` | live | STRIDE, assets, trust boundaries, mitigations |
| 56 | +| `docs/DEPLOYMENT-RUNBOOK.adoc` | live | Build, container, VeriSimDB main+backup, health, backup/restore |
| 57 | +| `SECURITY.md` | live | Vulnerability reporting |
| 58 | +| Release checklist | *planned* | v1.0.0 must/should/could + sign-off criteria |
| 59 | +| CI/CD guide | *planned* | `.github/workflows/` structure, standards-estate reusables (pins `4ddc926`), staleness check, adding a check |
| 60 | +| Security-scanning runbook | *planned* | Running/interpreting Hypatia + panic-attack + Scorecard; the `.hypatia-ignore` suppression mechanism (NOT `.hypatia-baseline.json` — see `NEUROSYM.a2ml`) |
| 61 | +| Container/quadlet ops | *thin* | Expand the runbook: `.container` format, systemd user units, day-to-day ops |
| 62 | +|=== |
| 63 | + |
| 64 | +== Machine-readable layer |
| 65 | +_For AI agents and tooling. Read `0-AI-MANIFEST.a2ml` FIRST._ |
| 66 | + |
| 67 | +* `0-AI-MANIFEST.a2ml` — canonical entry point, invariants, startup checklist. |
| 68 | +* `.machine_readable/6a2/` — `STATE.a2ml` (status, blockers, session history), `META`, `ECOSYSTEM`, `AGENTIC`, `NEUROSYM` (Hypatia config + `.hypatia-ignore` scope), `PLAYBOOK`. |
| 69 | +* `.machine_readable/` contractiles — `INTENT`/`MUST`/`TRUST`/`DUST` (purpose, hard CI rules, trust boundaries, cleanup). |
| 70 | +* `.hypatia-ignore` — reviewed false-positive suppressions (the active mechanism). |
| 71 | +* `.claude/CLAUDE.md` — human-friendly codebase guide. |
| 72 | + |
| 73 | +== Wiki status |
| 74 | +`docs/wikis/` is a stub that declares an intent to sync to a forge-hosted wiki but |
| 75 | +is **unpopulated**. The `docs/` tree also carries several empty placeholder |
| 76 | +subtrees (`theory/`, `reports/`, parts of `practice/`). |
| 77 | + |
| 78 | +*Decision pending:* either populate `docs/wikis/` and sync it, **or** (recommended) |
| 79 | +consolidate all narrative under `docs/` using the three audience paths above and |
| 80 | +prune the empty scaffolding. Until then, this index is the single navigation point. |
0 commit comments