move repos into monorepo
This commit is contained in:
58
bin/supervisor/docs/RESTRUCTURE.md
Normal file
58
bin/supervisor/docs/RESTRUCTURE.md
Normal file
@@ -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.
|
||||
Reference in New Issue
Block a user