Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/xxyoudeadpunkxx/signal-rail/llms.txt

Use this file to discover all available pages before exploring further.

The Signal Rail Workstation is signal_rail_workstation_final.html — a self-contained, offline-first application distributed as a single HTML file. Open it in any modern browser and it becomes a full local interface for reading, inspecting, staging, and writing to a live Signal Rail instance. There is no server to run, nothing to install, and no internet connection required. The workstation does not replace the canonical .txt files and does not change authority — it is a human-facing surface built on top of them.

Opening the workstation

1

Open the HTML file in a browser

Open signal_rail_workstation_final.html directly in Chrome, Edge, or another browser with File System Access API support. No local server is needed — double-clicking the file or dragging it into the browser address bar is sufficient.
2

Mount your Signal Rail instance folder

Click Open Folder in the utility bar. Select the folder containing your deployed Signal Rail instance. The browser will request read/write permission for the folder. Once granted, the workstation reads all canonical files and populates the surface grid.
3

Confirm the source mode

After mounting, the workstation enters live source mode. The status indicator in the utility bar reflects this. If system checks detect any issues — missing files, broken marker contracts, duplicate IDs — the System Checks modal will open automatically.
4

Alternatively, import a snapshot

If you do not have the folder available, click Import Snapshot and select a previously exported .json snapshot file. The workstation enters snapshot source mode and populates all views from the snapshot data.

The four main views

The READ view is the primary inspection surface for a live Signal Rail instance.Surface map grid — displays all 15 surface definitions as cards. Each card shows the surface name, its canonical role, and live/sensitive status. Click a surface to load it in the main reading pane.Structured mode — renders the selected surface according to its display contract. Each surface type has its own rendering format:
  • working_state — renders the current state, active work, blockers, and next move as structured sections
  • entry_cards — renders named entry sections as individual readable cards
  • section_outline — renders section headers with collapsible content
  • map_hybrid — renders both structured metadata and raw text for map-type surfaces
  • orientation_compiled — renders orientation fields as a clean compiled view
  • freeze_state — renders freeze entries with id, principle, and reopening trigger
Raw mode — shows the plain text content of the selected file exactly as it exists on disk.Inspect sidebar — displays metadata about the selected surface: its purpose, what it governs, whether it is marked live or sensitive, and any workstation-level notes about reading boundaries.

Source modes

The workstation operates in one of three source modes at any time:
ModeMeaning
unmountedNo folder or snapshot has been loaded. All views are empty.
liveA local folder is mounted via the File System Access API. Reads and writes go directly to canonical .txt files.
snapshotA JSON snapshot has been imported. All views are populated from the snapshot. Writing is not available.
The current source mode is always visible in the utility bar. Switch between modes using Open Folder (to go live), Import Snapshot (to load a snapshot), or Refresh (to re-read the current live folder).

Snapshot import and export

Use snapshots to review a previous instance state, share an instance view without sending the raw files, or work offline when the original folder is not available.
  • Export Snapshot — captures all canonical file contents into a single .json file. The snapshot includes file names, raw content, and a timestamp.
  • Import Snapshot — loads a .json snapshot and populates all four views from it. The workstation enters snapshot source mode. No writes can be made while in snapshot mode.
Snapshots are point-in-time captures. They do not stay in sync with live folder changes — refresh the live folder to pick up any edits made outside the workstation.

System checks

The System Checks modal can be opened manually from the utility bar or triggered automatically on load when issues are detected. It runs the same checks shown in the SYSTEM health grid and displays them in a grouped, readable format with pass/fail indicators and guidance for each failure. Run system checks any time you are unsure whether the instance is in a valid state — particularly after manual edits to canonical files, after importing a snapshot from an external source, or before a substantive write operation. The utility bar includes a global search box that searches across all workstation content simultaneously:
ScopeWhat is searched
surfacesSurface names and canonical roles (READ view)
write actionsWrite action card names and target canonicals (WRITE view)
referenceReference mini-layer content (SYSTEM view)
system actionsSource operations and system navigator items (SYSTEM view)
dashboard panesOverview, Radar, and Timeline section labels (DASHBOARD view)
Use arrow keys to navigate results and Enter to execute the selected action. The search box supports keyboard-only navigation throughout.

Important limits

File System Access API is required for live folder mounting and write operations. Chrome and Edge support this API. Firefox does not — use Import Snapshot mode in Firefox to read a snapshot, but be aware that write operations will not be available.The workstation does not change canonical authority. It is a reading and staging surface. The canonical .txt files remain the source of truth. The workstation has no authority to promote material, override routing rules, or bypass the entry sequence defined in 00_runtime_entry.txt and 06_ai_to_ai.txt.

Build docs developers (and LLMs) love