Documentation

This folder is the source of truth for all project documentation. It is also published to the project GitHub Wiki automatically (see Wiki sync below). The content is written to read well both when browsing the repo and on the Wiki tab.

👉 Start at Home, or jump straight in:

Section	What's inside
Getting Started	Quick start, installation, importing a ROM, first launch
User Guide	Every user-facing feature: saves, display, audio, input, cheats, navigation, and more
Widgets	The floating panels (inventory, checks, cheats, navigation, debug, logs, dataset)
Architecture	Zones & invariants, the WASM bridge, asset extraction, navigation, Electron/IPC
Game Hooks Reference	Every Wasm* export and GameHook_* callback crossing the C↔JS boundary
Contributing	Build from source, WASM build, coding standards, testing, design system
Legal	Third-party licenses bundled with the app

The full navigation menu is _Sidebar.md (rendered as the Wiki sidebar).

Conventions

• Short, single-purpose files, grouped into deep logical folders. The code follows the same rule (coding standards).
• Every doc starts with a <!-- @layer docs @kind doc --> tag (see file tagging).
• Links are relative .md paths so they resolve both in-repo and on the Wiki.

Wiki sync

Pushes to master that touch docs/** mirror this folder to the *.wiki repo via .github/workflows/docs-wiki-sync.yml. Edit docs here, never on the Wiki (Wiki edits are overwritten on the next sync).