From 0a617ad3591b0b3bca047ce4e75e842da4e66bbd Mon Sep 17 00:00:00 2001
From: Timur Gordon <31495328+timurgordon@users.noreply.github.com>
Date: Thu, 6 Nov 2025 14:11:09 +0100
Subject: [PATCH] Add restructure documentation

---
 RESTRUCTURE.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 RESTRUCTURE.md

diff --git a/RESTRUCTURE.md b/RESTRUCTURE.md
new file mode 100644
index 0000000..1b92af4
--- /dev/null
+++ b/RESTRUCTURE.md
@@ -0,0 +1,58 @@
+# Repository Restructure
+
+## Changes Made
+
+The supervisor repository has been restructured to follow a cleaner organization:
+
+### Before:
+```
+supervisor/
+├── clients/
+│   ├── openrpc/          # OpenRPC client library
+│   └── admin-ui/         # Admin UI (Yew WASM app)
+├── src/                  # Main supervisor library
+└── cmd/                  # Supervisor binary
+```
+
+### After:
+```
+supervisor/
+├── client/               # OpenRPC client library (renamed from clients/openrpc)
+├── ui/                   # Admin UI (renamed from clients/admin-ui)
+├── src/                  # Main supervisor library
+└── cmd/                  # Supervisor binary
+```
+
+## Package Names
+
+The package names remain unchanged:
+- **Client**: `hero-supervisor-openrpc-client`
+- **UI**: `supervisor-admin-ui`
+- **Main**: `hero-supervisor`
+
+## Git Dependencies
+
+External projects using Git URLs will automatically pick up the new structure:
+
+```toml
+# This continues to work
+hero-supervisor-openrpc-client = { git = "https://git.ourworld.tf/herocode/supervisor.git" }
+```
+
+Cargo will find the package by name regardless of its location in the repository.
+
+## Local Path Dependencies
+
+If you have local path dependencies, update them:
+
+```toml
+# Old
+hero-supervisor-openrpc-client = { path = "../supervisor/clients/openrpc" }
+
+# New
+hero-supervisor-openrpc-client = { path = "../supervisor/client" }
+```
+
+## Scripts and Documentation
+
+All references in scripts, documentation, and examples have been updated to reflect the new structure.