You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: illustrated wiki (Mermaid) + 5 reference docs (Phase 12)
Completes the remaining `planned` documentation. Two complementary layers:
Illustrated wiki (docs/wikis/, GitHub-native Mermaid diagrams):
Home, 02-Architecture, 03-Installation, 04-Probing-and-Games,
05-The-Proven-ABI, 06-HTTP-Capability-Gateway, 07-GUI-and-Nexus-Setup,
08-Deployment-Topology, 09-Troubleshooting, 10-Contributing.
Deliberately blunt about what works today vs. what needs the estate;
09-Troubleshooting is the direct first-run "why isn't this working" guide.
Reference docs (AsciiDoc):
developer/FFI-MODULE-REFERENCE, developer/PANEL-EXTENSION-GUIDE,
developer/ARCHITECTURE-RATIONALE, maintainer/CI-CD-GUIDE,
maintainer/SECURITY-SCANNING-RUNBOOK.
docs/INDEX.adoc: mark all of the above live; add the wiki map; note the
standards-estate reusable pin has moved past the historically-cited SHA
(NEUROSYM.a2ml still cites the stale value — flagged for follow-up).
All content verified against source; tri-license SPDX headers
(CC-BY-SA-4.0 on docs). No code changes.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TaWWedv6VQqeZaPvc94keN
Copy file name to clipboardExpand all lines: docs/INDEX.adoc
+46-17Lines changed: 46 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,9 +21,12 @@ _You run and administer game servers via the Gossamer GUI and the `gsa` CLI._
21
21
| `README.adoc` | live | Overview, quick-start, `gsa` CLI reference, supported games
22
22
| `USER-CONFIG.md` | live | Nickel config: defaults, favourites, troubleshooting
23
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
24
+
| `docs/wikis/Home.md` | live | **Illustrated wiki** — narrative tour with Mermaid diagrams; start here
25
+
| `docs/wikis/03-Installation.md` | live | Honest install guide: what works today, exact prereqs, verify steps
26
+
| `docs/wikis/07-GUI-and-Nexus-Setup.md` | live | All 8 panels + the 7-step `nexus-setup` provisioning wizard (was undocumented)
27
+
| `docs/wikis/04-Probing-and-Games.md` | live | Probe pipeline + the 18-game profile/protocol/format table
28
+
| `docs/wikis/09-Troubleshooting.md` | live | Symptom → cause → fix for the common first-run failures
29
+
| Admin workflows | *thin* | Covered piecewise in the wiki (server-actions, config-history); a single end-to-end runbook is still a gap
27
30
|===
28
31
29
32
== Developers
@@ -37,11 +40,14 @@ _You build GSA, extend it, or contribute code across the Gossamer GUI → Zig FF
37
40
| `docs/developer/ABI-FFI-README.adoc` | live | Idris2 ABI + Zig FFI standard; C/Idris2/Rust/Julia examples (strong)
38
41
| `TOPOLOGY.md` | live | System architecture + data flow
39
42
| `docs/decisions/` | live | Architecture decision records (RSR adoption)
40
-
| FFI module reference | *planned* | Per-module docs for the 11 FFI modules (signatures, the 18 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
+
| `docs/developer/FFI-MODULE-REFERENCE.adoc` | live | Per-module docs for the FFI modules (every `gossamer_gsa_*` symbol, the 18 result codes, the handle lifecycle)
44
+
| `docs/developer/PANEL-EXTENSION-GUIDE.adoc` | live | Panel anatomy + the clade system; `nexus-setup` as the worked example; the `host.html` wiring points
45
+
| `docs/wikis/05-The-Proven-ABI.md` | live | The machine-checked ABI contract (codegen pipeline, 18 codes, linear handles) — the differentiator, illustrated
46
+
| `docs/wikis/06-HTTP-Capability-Gateway.md` | live | How outbound HTTP is a declared, deadline-bounded, default-deny capability
47
+
| `docs/wikis/10-Contributing.md` | live | Build/test, the ABI regen rule, conventions, tri-license SPDX, branch/PR flow
48
+
| Game-profile authoring | *thin* | See `docs/wikis/04-Probing-and-Games.md`; a deep field-type/validation/debugging guide is still a gap
43
49
| `docs/developer/CONFIG-FORMATS.adoc` | live | The 8 formats, detection order, `addField` invariants, YAML scope, and how to add a parser
44
-
| Architecture rationale | *planned* | Why Ephapax / Idris2 / Zig / VeriSimDB; when to touch each layer
50
+
| `docs/developer/ARCHITECTURE-RATIONALE.adoc` | live | Why Ephapax / Idris2 / Zig / VeriSimDB; when to touch each layer
45
51
|===
46
52
47
53
== Maintainers
@@ -56,11 +62,18 @@ _You release, run CI/CD, operate containers, and manage governance + security sc
| Container/quadlet ops | *thin* | Expand the runbook: `.container` format, systemd user units, day-to-day ops
65
+
| `docs/maintainer/CI-CD-GUIDE.adoc` | live | All 16 workflows, the ABI-contract + version-drift gates, standards-estate reusable pins, adding a check
66
+
| `docs/maintainer/SECURITY-SCANNING-RUNBOOK.adoc` | live | Running/interpreting Hypatia + panic-attack + Scorecard; the `.hypatia-ignore` suppression mechanism (NOT `.hypatia-baseline.json` — see `NEUROSYM.a2ml`)
67
+
| `docs/wikis/08-Deployment-Topology.md` | live | Podman quadlets, the two VeriSimDB instances (`:8090`/`:8091`), the `container/` map — the illustrated deployment view
68
+
| Container/quadlet ops | *thin* | The wiki covers the topology; a day-to-day systemd-unit ops guide is still a gap
62
69
|===
63
70
71
+
NOTE: the standards-estate reusable-workflow pin cited historically as `4ddc926`
72
+
has since been bumped (governance/scorecard and secret-scanner/mirror now pin
73
+
newer SHAs — see `docs/maintainer/CI-CD-GUIDE.adoc` for the current values).
74
+
`.machine_readable/6a2/NEUROSYM.a2ml` still cites the stale SHA and should be
75
+
updated in a follow-up.
76
+
64
77
== Machine-readable layer
65
78
_For AI agents and tooling. Read `0-AI-MANIFEST.a2ml` FIRST._
66
79
@@ -70,14 +83,30 @@ _For AI agents and tooling. Read `0-AI-MANIFEST.a2ml` FIRST._
70
83
* `.hypatia-ignore` — reviewed false-positive suppressions (the active mechanism).
0 commit comments