docs(ui): finalize MVP plan structure and de-archaeologize topic docs
MVP web client (Phases 1-30) is complete; reorganize planning + living docs around that. - PLAN.md kept as the staged MVP record (1-30) with a status block + pointers; removed the 31-36 stages, regression scenarios, and deferred-TODO section (moved out); fixed a stale cross-machine plan path. - ui/PLAN-finalize.md (new): active web-finalization plan in 8 stages (visual system, a11y, i18n, error UX, PWA, build hygiene, docs, owner manual-QA loop); absorbs former Phases 33 and 35. - ui/ROADMAP.md (new): post-MVP (Wails, Capacitor, realistic projection, acceptance + regression scenarios) and triaged deferred follow-ups. - ui/docs/README.md (new): grouped topic-doc index. - De-archaeologized all 20 ui/docs topic docs + ui/README.md + ui/core/README.md: stripped Phase-N build history, rewritten as current-state; deferred work now points at ROADMAP.md / PLAN-finalize.md. Docs-only; no code change. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,60 @@
|
||||
# UI client — topic docs
|
||||
|
||||
Deeper, topic-based documentation for the Galaxy web/cross-platform UI
|
||||
client, beyond what fits in [`../README.md`](../README.md). Each file
|
||||
describes how one area works (current state); the staged build history
|
||||
lives in [`../PLAN.md`](../PLAN.md), the active web finalization in
|
||||
[`../PLAN-finalize.md`](../PLAN-finalize.md), and deferred work in
|
||||
[`../ROADMAP.md`](../ROADMAP.md).
|
||||
|
||||
## Foundation & platform
|
||||
|
||||
- [navigation.md](navigation.md) — routes, the sidebar tabs, and the
|
||||
state-preservation rules across view/tab switches.
|
||||
- [storage.md](storage.md) — the `KeyStore` and `Cache` abstractions and
|
||||
their web (IndexedDB) implementations.
|
||||
- [game-state.md](game-state.md) — decoding the FlatBuffers report into
|
||||
`GameReport` and the `GameState` / rendered-report stores.
|
||||
- [sync-protocol.md](sync-protocol.md) — order-draft sync, turn cutoff,
|
||||
conflict handling, and auto-pause.
|
||||
- [events.md](events.md) — the signed push channel and event handling.
|
||||
- [calc-bridge.md](calc-bridge.md) — the `pkg/calc` → WASM → TypeScript
|
||||
bridge, with the live function surface and parity rules.
|
||||
- [wasm-toolchain.md](wasm-toolchain.md) — building `ui/core` to
|
||||
`core.wasm` with TinyGo.
|
||||
- [testing.md](testing.md) — the UI test layers (Vitest + Playwright).
|
||||
|
||||
## Auth & lobby
|
||||
|
||||
- [auth-flow.md](auth-flow.md) — device keypair, email-code login, and
|
||||
request signing on the client.
|
||||
- [lobby.md](lobby.md) — the lobby/game-list UI and membership flows.
|
||||
|
||||
## Map & active views
|
||||
|
||||
- [renderer.md](renderer.md) — the PixiJS map renderer contract (world
|
||||
model, hit-test, torus / no-wrap).
|
||||
- [order-composer.md](order-composer.md) — the order tab and the
|
||||
optimistic order overlay.
|
||||
- [report-view.md](report-view.md) — the Reports view.
|
||||
|
||||
## Tools & inspectors
|
||||
|
||||
- [calculator-ux.md](calculator-ux.md) — the ship-class calculator
|
||||
(design + goal-seek + planet build + reach circles + modernization).
|
||||
- [science-designer-ux.md](science-designer-ux.md) — the science
|
||||
designer.
|
||||
- [ship-group-actions.md](ship-group-actions.md) — ship-group inspector
|
||||
actions (move, send, upgrade, …).
|
||||
- [cargo-routes-ux.md](cargo-routes-ux.md) — cargo-route composition and
|
||||
reach filtering.
|
||||
|
||||
## Combat & comms
|
||||
|
||||
- [battle-viewer-ux.md](battle-viewer-ux.md) — the battle viewer.
|
||||
- [diplomail-ui.md](diplomail-ui.md) — the diplomatic-mail view.
|
||||
|
||||
## Localisation
|
||||
|
||||
- [i18n.md](i18n.md) — the localisation mechanism and translation
|
||||
bundles.
|
||||
Reference in New Issue
Block a user