Audience-segmented map of the GSA documentation. Start here, then pick your role.
|
Note
|
Status legend: live = written and current; thin = exists but covers only
setup/basic-run; planned = a known gap, scoped below, tracked for the v1.0.0
documentation pass. See |
You run and administer game servers via the Gossamer GUI and the gsa CLI.
| Document | Status | Covers |
|---|---|---|
|
live |
Overview, quick-start, |
|
live |
Nickel config: defaults, favourites, troubleshooting |
|
thin |
One-liner pointer — not a real getting-started |
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). |
Game-profile selection |
planned |
Which game → which of the 18 profiles; port/protocol table |
Admin workflows |
planned |
Add a server; manage config across servers; roll back via config history |
You build GSA, extend it, or contribute code across the Gossamer GUI → Zig FFI → Idris2 ABI → VeriSimDB stack.
| Document | Status | Covers |
|---|---|---|
|
live |
Architecture diagram, module map, "Adding a Game Profile" snippet |
|
live |
Idris2 ABI + Zig FFI standard; C/Idris2/Rust/Julia examples (strong) |
|
live |
System architecture + data flow |
|
live |
Architecture decision records (RSR adoption) |
FFI module reference |
planned |
Per-module docs for the 11 FFI modules (signatures, the 18 result codes, examples) |
Panel extension guide |
planned |
The PanLL clade system; registering a new panel; inheriting base clades |
Game-profile authoring |
thin |
Expand the README snippet: field types, validation, port/protocol, debugging |
|
live |
The 8 formats, detection order, |
Architecture rationale |
planned |
Why Ephapax / Idris2 / Zig / VeriSimDB; when to touch each layer |
You release, run CI/CD, operate containers, and manage governance + security scanning.
| Document | Status | Covers |
|---|---|---|
|
live |
Three-axis model, hygiene, ABI purity, panic-attack (strong) |
|
live |
STRIDE, assets, trust boundaries, mitigations |
|
live |
Build, container, VeriSimDB main+backup, health, backup/restore |
|
live |
Vulnerability reporting |
|
live |
CI gates (6 suites + ABI contract), version/license/docs gates, manual gates, tag steps |
CI/CD guide |
planned |
|
Security-scanning runbook |
planned |
Running/interpreting Hypatia + panic-attack + Scorecard; the |
Container/quadlet ops |
thin |
Expand the runbook: |
For AI agents and tooling. Read 0-AI-MANIFEST.a2ml FIRST.
-
0-AI-MANIFEST.a2ml— canonical entry point, invariants, startup checklist. -
.machine_readable/6a2/—STATE.a2ml(status, blockers, session history),META,ECOSYSTEM,AGENTIC,NEUROSYM(Hypatia config +.hypatia-ignorescope),PLAYBOOK. -
.machine_readable/contractiles —INTENT/MUST/TRUST/DUST(purpose, hard CI rules, trust boundaries, cleanup). -
.hypatia-ignore— reviewed false-positive suppressions (the active mechanism). -
.claude/CLAUDE.md— human-friendly codebase guide.
docs/wikis/ is a stub that declares an intent to sync to a forge-hosted wiki but
is unpopulated. The docs/ tree also carries several empty placeholder
subtrees (theory/, reports/, parts of practice/).
Decision pending: either populate docs/wikis/ and sync it, or (recommended)
consolidate all narrative under docs/ using the three audience paths above and
prune the empty scaffolding. Until then, this index is the single navigation point.
|
Note
|
a mechanical prune is not clean — verification/, docs/theory/,
docs/reports/, and docs/wikis/ are referenced by the governance layer
(.machine_readable/anchors/ANCHOR.a2ml, docs/governance/MAINTENANCE-CHECKLIST,
features/panic-attacker/). Deleting the trees without updating those references
risks breaking governance/CI expectations, so the prune is deferred to a
dedicated, reviewed change that updates the references in lockstep rather than
bundled into an automated docs pass.
|