docs: establish project documentation baseline

Provide installation, security, contribution, licensing, and release guidance while removing user-specific service configuration.
2026-07-27 15:15:56 +02:00
parent b7fea83ed6
commit 7cc15cca92
11 changed files with 529 additions and 5 deletions
@@ -1,7 +1,47 @@
-# Tauri + React + Typescript
+# Pi Status UI

-This template should help get you started developing with Tauri, React and Typescript in Vite.
+## Reason for existence

-## Recommended IDE Setup
+Provide the desktop control surface for Pi Status Bridge. The UI presents bridge state and forwards user intent; it never owns Pi sessions, worktree routing, or approval policy.

- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
+## Requirements
+
+- Node.js 20+.
+- Rust stable and the native dependencies required by [Tauri v2](https://v2.tauri.app/start/prerequisites/).
+- A running Pi Status Bridge socket. By default the app uses `$XDG_RUNTIME_DIR/pi-status-bridge/bridge.sock`; set `PI_STATUS_BRIDGE_SOCKET` to override it.
+
+## Develop
+
+From the repository root:
+
+```bash
+npm --prefix ui ci
+node src/bridge/cli.js --worktree "$HOME"
+npm --prefix ui run tauri dev
+```
+
+The second command starts the bridge; run it in a separate terminal. The Tauri app connects to it on startup.
+
+## Commands
+
+```bash
+npm --prefix ui run dev       # Vite frontend only
+npm --prefix ui run build     # typecheck and build frontend assets
+npm --prefix ui run tauri dev # run the desktop client
+npm --prefix ui run tauri build # package a desktop bundle
+```
+
+## Boundaries
+
+- The UI sends operations only to the selected bridge agent.
+- Extension responses are forwarded unchanged to Pi.
+- The UI must not add a network transport or persist competing model/thinking defaults.
+
+## Verification
+
+```bash
+cargo test --manifest-path ui/src-tauri/Cargo.toml
+npm --prefix ui run build
+```
+
+See the [root README](../README.md) for bridge setup and repository-wide verification.