Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
fa35017
docs: rework user-facing docs around lan mode + web frontend
NicholasClooney Sep 12, 2026
259e92d
docs: add web frontend screenshots for user docs
NicholasClooney Sep 12, 2026
263c85a
docs: add TUI screenshot and caption each README image
NicholasClooney Sep 12, 2026
269a5b5
docs(user): note how to attach a second TUI via connect
NicholasClooney Sep 12, 2026
7469ae2
docs: note connect command in README quick start
NicholasClooney Sep 12, 2026
14a020f
docs: clarify lan is headless; TUI+TTS requires a connect client
NicholasClooney Sep 12, 2026
28187ba
docs: show full URL and host:port forms for connect
NicholasClooney Sep 12, 2026
20fa101
docs: add contributing and license sections to README
NicholasClooney Sep 12, 2026
ce16ffe
docs: add tests build badge and Discord badge to README
NicholasClooney Sep 12, 2026
fe5261b
docs: reorder tail sections to Development, Repo Layout, Contributing…
NicholasClooney Sep 12, 2026
372de43
docs: add table of contents to README
NicholasClooney Sep 12, 2026
3b26cf2
docs: shrink README screenshots to 50% width
NicholasClooney Sep 12, 2026
bbdf4bf
docs: shrink What You Get by folding bullets into a one-line lead
NicholasClooney Sep 12, 2026
447b8e8
docs: collapse README screenshots into expandable details blocks
NicholasClooney Sep 12, 2026
556a8bd
docs: add hint that screenshot sections are expandable
NicholasClooney Sep 12, 2026
c037dfc
docs: expand each What You Get section with concrete capabilities
NicholasClooney Sep 13, 2026
32a35f1
docs: add The Idea section to frame two-way haul as flagship co-pilot
NicholasClooney Sep 13, 2026
4bbdb2e
docs: link live stream demo in The Idea section
NicholasClooney Sep 13, 2026
5c67732
docs: swap demo video to correct stream and timestamp
NicholasClooney Sep 13, 2026
e1114cc
docs: add VR haul hero image to The Idea section
NicholasClooney Sep 13, 2026
32687d0
docs: use custom VR image as the video preview
NicholasClooney Sep 13, 2026
ff691d7
docs: add YouTube play button overlay; shrink hero to 50% width
NicholasClooney Sep 13, 2026
5d119f3
docs: remove getting-started/ folder, superseded by docs/user/
NicholasClooney Sep 13, 2026
4330c09
docs: correct Spansh route section — autofill, waypoint runner, auto-…
NicholasClooney Sep 13, 2026
0c16593
docs: start First Haul from a docked state
NicholasClooney Sep 13, 2026
a97db15
docs: recommend secondary device for web UI since ED must stay foregr…
NicholasClooney Sep 13, 2026
1ef16c1
docs: clarify haul can start from any phase, TUI or web
NicholasClooney Sep 13, 2026
8288fb7
docs: add table of contents to each user doc
NicholasClooney Sep 13, 2026
1937643
docs: reword haul phases as unordered; note EDCR picks the next one
NicholasClooney Sep 13, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
217 changes: 92 additions & 125 deletions README.md

Large diffs are not rendered by default.

44 changes: 25 additions & 19 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,39 @@
# Docs Index

## Start Here
## Start Here (Users)

- [getting-started/quickstart.md](getting-started/quickstart.md): setup, first checks, and first runtime commands
- [operators/control-room.md](operators/control-room.md): primary day-to-day operator guide
- [operators/bindings-files.md](operators/bindings-files.md): `.binds` backup, restore, and preset apply
- [user/install.md](user/install.md): install Python, `uv`, platform prerequisites.
- [user/bindings-setup.md](user/bindings-setup.md): Elite bindings required before first run.
- [user/getting-started.md](user/getting-started.md): recommended TUI + web LAN setup.
- [user/haul-workflow.md](user/haul-workflow.md): end-to-end haul walkthrough plus `haul.toml`.
- [user/commands-reference.md](user/commands-reference.md): every Control Room command.
- [user/troubleshooting.md](user/troubleshooting.md): input, journal, and bindings checks.

## Operator Guides
## Operator Reference

- [operators/input-timing.md](operators/input-timing.md): human-style delay, hold, and typing randomization settings
- [operators/market-timing.md](operators/market-timing.md): market buy-hold tuning and sell max rapid-tap settings
- [operators/manual-journal-routine-testing.md](operators/manual-journal-routine-testing.md): low-level manual validation outside Control Room
- [operators/control-room.md](operators/control-room.md): run modes, panels, and haul behavior specifics.
- [operators/control-room-remote.md](operators/control-room-remote.md): multi-client / observer semantics.
- [operators/bindings-files.md](operators/bindings-files.md): `.binds` backup, restore, and shipped preset apply.
- [operators/input-timing.md](operators/input-timing.md): human-style delay, hold, and typing randomization.
- [operators/market-timing.md](operators/market-timing.md): market buy-hold and sell-max tuning.
- [operators/manual-journal-routine-testing.md](operators/manual-journal-routine-testing.md): low-level manual validation outside Control Room.

## Diagnostics

- [diagnostics/cli-reference.md](diagnostics/cli-reference.md): utility and diagnostics commands
- [diagnostics/bindings-reference.md](diagnostics/bindings-reference.md): Elite binding names that matter to this runtime
- [diagnostics/cli-reference.md](diagnostics/cli-reference.md)
- [diagnostics/bindings-reference.md](diagnostics/bindings-reference.md)

## Maintainer Handoff

- [status/README.md](status/README.md): maintained status entrypoint and area map
- [status/](status/): split current-state handoff files by durable area
- [iteration-logs/](iteration-logs/): per-iteration maintained notes, one file per substantive work session
- [iteration-archive.md](iteration-archive.md): generated archive of iteration logs, refreshed whenever iteration-log changes are being committed, pushed, or sent for review
- [status-archive.md](status-archive.md): legacy archived validation and older pre-migration handoff notes
- [status/README.md](status/README.md): maintained status entrypoint and area map.
- [status/](status/): split current-state handoff files by durable area.
- [iteration-logs/](iteration-logs/): maintained per-session notes.
- [iteration-archive.md](iteration-archive.md): generated archive, refreshed alongside iteration-log changes.
- [status-archive.md](status-archive.md): legacy archived validation and pre-migration handoff notes.

## Deep Reference

- [plans/](plans/): implementation plans
- [research/](research/): deeper research and behavior-reference material
- [design/](design/): design notes
- [devlog/](devlog/): older session-style notes
- [plans/](plans/): implementation plans.
- [research/](research/): deeper research and behavior-reference material.
- [design/](design/): design notes.
- [devlog/](devlog/): older session-style notes.
3 changes: 3 additions & 0 deletions docs/assets/haul-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/assets/haul-vr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/assets/quick-stats.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/assets/spansh-routes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/assets/tui-control-room.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
142 changes: 0 additions & 142 deletions docs/getting-started/quickstart.md

This file was deleted.

17 changes: 7 additions & 10 deletions docs/operators/control-room-remote.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Control Room Remote Observer Mode
# Control Room Multi-Client Mode

This document covers the current `serve` / `connect` split for Control Room.
This document covers the `serve` / `connect` model when **more than one client** connects to the same Control Room server (e.g. TUI on the runtime host plus a browser plus a second TUI on another laptop).

For normal embedded local use, start with [control-room.md](control-room.md).
For the recommended single-user LAN setup (one `lan` server + one browser + local TUI for TTS), see [../user/getting-started.md](../user/getting-started.md). For the operator reference on run modes, see [control-room.md](control-room.md).

## Purpose

Use remote observer mode when one machine should own the runtime and one or more other clients should watch or operate it over the LAN.
Use multi-client mode when one machine owns the runtime and one or more additional clients should watch or take over control over the LAN.

Current model:

Expand All @@ -20,17 +20,14 @@ Current model:

## Commands

Start a server on the machine that owns the Elite runtime:
Server run modes are documented in [control-room.md](control-room.md#run-modes). A quick summary for multi-client setups:

```sh
uv run python3 control_room.py serve --token 1001
uv run python3 control_room.py local --token 1001
uv run python3 control_room.py lan --port 8765 --token 1001
uv run python3 control_room.py serve --lan --port 8765 --token 1001
uv run python3 control_room.py lan --token 1001
uv run python3 control_room.py serve --host 0.0.0.0 --port 8765 --token 1001
```

Use `local` to bind loopback (`127.0.0.1`) explicitly. Use `lan` or `serve --lan` when clients should connect from the same network and you want Control Room to bind to the detected non-loopback IPv4 address, preferring RFC1918 addresses and skipping VPN-owned ranges like `198.18/15` (Cloudflare WARP) and `100.64/10` (CGNAT). Use `--host` for an explicit bind address, including `0.0.0.0` for all interfaces.
Pass an explicit `--token` when you want to override the default `edcr`. All clients must use the same token.

Connect from a client:

Expand Down
Loading
Loading