Skip to content

Commit ab21f4d

Browse files
committed
optimize doc
1 parent 42d3fbc commit ab21f4d

28 files changed

Lines changed: 2236 additions & 3956 deletions

documents/docs/getting_started/migration_ufo2_to_galaxy.md

Lines changed: 16 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -74,16 +74,10 @@ graph LR
7474

7575
### Architecture Evolution
7676

77-
<table>
78-
<tr>
79-
<th width="33%">UFO v1</th>
80-
<th width="33%">UFO²</th>
81-
<th width="33%">UFO³ Galaxy</th>
82-
</tr>
83-
<tr>
84-
<td valign="top">
77+
#### UFO v1 Architecture
8578

8679
**Multi-Agent (GUI-Only)**
80+
8781
```
8882
User Request
8983
@@ -95,15 +89,16 @@ Windows Apps (GUI)
9589
```
9690

9791
**Capabilities:**
92+
9893
- Multi-app workflows
9994
- Pure screenshot + click/type
10095
- No API integration
10196
- Single device
10297

103-
</td>
104-
<td valign="top">
98+
#### UFO² Architecture
10599

106100
**Two-Tier Hierarchy (Hybrid)**
101+
107102
```
108103
User Request
109104
@@ -115,16 +110,17 @@ Windows Apps (GUI + API)
115110
```
116111

117112
**Capabilities:**
113+
118114
- Multi-app workflows
119115
- Desktop orchestration
120116
- Hybrid GUI–API execution
121117
- Deep OS integration
122118
- Single device
123119

124-
</td>
125-
<td valign="top">
120+
#### UFO³ Galaxy Architecture
126121

127122
**Constellation Model (Distributed)**
123+
128124
```
129125
User Request
130126
@@ -138,15 +134,12 @@ Cross-Platform Apps
138134
```
139135

140136
**Capabilities:**
137+
141138
- Multi-device workflows
142139
- Parallel execution
143140
- Dynamic adaptation
144141
- Heterogeneous platforms
145142

146-
</td>
147-
</tr>
148-
</table>
149-
150143
---
151144

152145
## 🎯 When to Use Which?
@@ -210,7 +203,7 @@ Understanding how UFO² concepts map to Galaxy:
210203
| **Action** | **TaskStar** | Executable unit (but on specific device) |
211204
| **Blackboard** | **Task Results** | Inter-task communication |
212205
| **Config File** | `config/ufo/``config/galaxy/` | Configuration location |
213-
| **Execution Mode** | `--mode agent-server` | Device runs as server |
206+
| **Execution Mode** | `python -m ufo.server.app --port <port>` | Device runs as WebSocket server |
214207

215208
### Architecture Translation
216209

@@ -395,17 +388,17 @@ LOG_TO_MARKDOWN: true # Generate trajectory reports
395388

396389
#### Step 1: Start UFO² as Agent Server
397390

398-
**On each device** (Windows, Linux, etc.), run UFO² in server mode:
391+
**On each device** (Windows, Linux, etc.), run UFO² server:
399392

400393
```bash
401394
# Windows Desktop
402-
python -m ufo --mode agent-server --port 5005
395+
python -m ufo.server.app --port 5005
403396

404397
# Linux Workstation
405-
python -m ufo --mode agent-server --port 5001
398+
python -m ufo.server.app --port 5001
406399

407400
# GPU Server
408-
python -m ufo --mode agent-server --port 5002
401+
python -m ufo.server.app --port 5002
409402
```
410403

411404
**What this does:**
@@ -469,7 +462,7 @@ asyncio.run(main())
469462
#### Galaxy API (After):
470463

471464
```python
472-
from galaxy.galaxy_client import GalaxyClient
465+
from galaxy import GalaxyClient
473466
import asyncio
474467

475468
async def main():
@@ -733,7 +726,7 @@ Use this checklist to track your migration progress:
733726
- [ ] **Decide migration strategy** (hybrid vs full Galaxy)
734727
- [ ] **Preserve UFO² config** (`config/ufo/` untouched)
735728
- [ ] **Create Galaxy config** (`config/galaxy/agent.yaml`, `devices.yaml`)
736-
- [ ] **Start devices as agent-servers** (each device runs `--mode agent-server`)
729+
- [ ] **Start devices as servers** (each device runs `python -m ufo.server.app --port <port>`)
737730
- [ ] **Test single-device workflow** (verify connectivity)
738731
- [ ] **Test multi-device workflow** (cross-platform task)
739732
- [ ] **Review trajectory reports** (`logs/galaxy/*/output.md`)

documents/docs/getting_started/quick_start_linux.md

Lines changed: 34 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -314,29 +314,29 @@ curl -X POST http://172.23.48.1:5001/api/dispatch \
314314
"task_name": "list_tmp_files"
315315
}'
316316
```
317-
318-
**Using Python:**
319-
```python
320-
import requests
321-
322-
response = requests.post(
323-
"http://172.23.48.1:5001/api/dispatch",
324-
json={
325-
"client_id": "linux_agent_1",
326-
"request": "List all files in the /tmp directory",
327-
"task_name": "list_tmp_files"
328-
}
329-
)
330-
print(response.json())
331-
```
332-
333-
**Using HTTPie:**
334-
```bash
335-
http POST http://172.23.48.1:5001/api/dispatch \
336-
client_id=linux_agent_1 \
337-
request="List all files in the /tmp directory" \
338-
task_name=list_tmp_files
339-
```
317+
318+
**Using Python:**
319+
```python
320+
import requests
321+
322+
response = requests.post(
323+
"http://172.23.48.1:5001/api/dispatch",
324+
json={
325+
"client_id": "linux_agent_1",
326+
"request": "List all files in the /tmp directory",
327+
"task_name": "list_tmp_files"
328+
}
329+
)
330+
print(response.json())
331+
```
332+
333+
**Using HTTPie:**
334+
```bash
335+
http POST http://172.23.48.1:5001/api/dispatch \
336+
client_id=linux_agent_1 \
337+
request="List all files in the /tmp directory" \
338+
task_name=list_tmp_files
339+
```
340340

341341
**Successful Response:**
342342

@@ -574,11 +574,11 @@ sudo apt-get install autossh # Debian/Ubuntu
574574
# Start persistent tunnel
575575
autossh -M 0 \
576576
-N \
577-
-L 5001:server:5001 \
578-
-o ServerAliveInterval=60 \
579-
-o ServerAliveCountMax=3 \
580-
user@gateway
581-
```
577+
-L 5001:server:5001 \
578+
-o ServerAliveInterval=60 \
579+
-o ServerAliveCountMax=3 \
580+
user@gateway
581+
```
582582

583583
> **ℹ️ Network Configuration:** For more network configuration details, see [Server Quick Start - Troubleshooting](../server/quick_start.md#common-issues-troubleshooting).
584584
@@ -716,14 +716,15 @@ devices:
716716
Once configured, you can launch Galaxy and it will automatically manage the Linux agents:
717717

718718
```bash
719-
python -m galaxy --config config/galaxy/devices.yaml
719+
python -m galaxy --interactive
720720
```
721721

722722
**Galaxy will:**
723-
1. ✅ Connect to all configured devices
724-
2. ✅ Orchestrate multi-device tasks
725-
3. ✅ Route tasks based on capabilities
726-
4. ✅ Monitor device health
723+
1. ✅ Automatically load device configuration from `config/galaxy/devices.yaml`
724+
2. ✅ Connect to all configured devices
725+
3. ✅ Orchestrate multi-device tasks
726+
4. ✅ Route tasks based on capabilities
727+
5. ✅ Monitor device health
727728

728729
> **ℹ️ Galaxy Documentation:** For detailed Galaxy configuration and usage, see:
729730
>

0 commit comments

Comments
 (0)