Skip to content

docs: rework user-facing docs around lan mode + web frontend - #25

Merged
NicholasClooney merged 29 commits into
mainfrom
docs/user-facing-rework
Sep 13, 2026
Merged

NicholasClooney merged 29 commits into
mainfrom
docs/user-facing-rework

Conversation

@NicholasClooney

Copy link
Copy Markdown
Collaborator

Summary

  • Reframes user-facing docs around the recommended run: control_room.py lan (headless server) + browser at :8765 for the web frontend + connect TUI for TTS callouts.
  • Adds a new docs/user/ set (install, bindings-setup, getting-started, haul-workflow, commands-reference, troubleshooting). Retires docs/getting-started/quickstart.md to a redirect stub. Trims docs/operators/control-room.md and reframes docs/operators/control-room-remote.md as multi-client mode rather than the default remote path.
  • Calls out the required arrow-key UI_Up/Down/Left/Right secondaries so galaxy-map automation does not silently misnav on default WASD bindings.
  • Reworks the README: adds tests + Discord badges, TOC, a The Idea section framing the two-way haul routine as a co-pilot (with a clickable VR hero image linking to the live-stream demo), four collapsible What You Get sections showing TUI + web dashboard + haul search + Spansh route with concrete capability bullets, and Contributing / License sections in the conventional tail order.
  • Adds screenshots to docs/assets/: tui-control-room.png, quick-stats.png, haul-search.png, spansh-routes.png, haul-vr.png (all via LFS).

Test plan

  • README renders correctly on GitHub (badges show, TOC anchors resolve, <details> blocks expand, hero image is clickable through to the YouTube timestamp).
  • Screenshots load from LFS on the branch.
  • docs/user/ index links resolve; docs/getting-started/quickstart.md redirect points at the right pages.
  • docs/operators/control-room.md and control-room-remote.md cross-links resolve; no duplicated haul prose.

Add docs/user/ set (install, bindings-setup, getting-started, haul-workflow,
commands-reference, troubleshooting) framing the recommended run as
`control_room.py lan` with the TUI for TTS and the browser at :8765 as the
main operator surface. Call out the required arrow-key UI_* secondaries so
galaxy-map automation does not silently misnav on default WASD bindings.

Slim README.md to an overview plus three web screenshots, retire the old
getting-started/quickstart.md to a redirect stub, and refactor
operators/control-room.md and operators/control-room-remote.md to remove
duplicated content and reframe remote mode as multi-client rather than the
default remote path.
@NicholasClooney
NicholasClooney merged commit 887f6fc into main Sep 13, 2026
5 checks passed
@NicholasClooney
NicholasClooney deleted the docs/user-facing-rework branch September 13, 2026 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant