Skip to content

Commit bd4b13e

Browse files
abrichrclaude
andcommitted
docs: add terminal output examples and success indicators to quick start
Enhanced the Quick Start section with: - "What You'll See" sections showing example terminal output for each command - Clear success indicators to help users verify things are working - Structured subsections for Installation, Collect, Learn, and Evaluate This addresses Phase 1 quick wins from documentation review (task a4441ff): highest value improvements that help users know when things are working correctly. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 60f4d93 commit bd4b13e

File tree

1 file changed

+57
-3
lines changed

1 file changed

+57
-3
lines changed

docs/index.md

Lines changed: 57 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,31 +65,85 @@ MIT licensed. Full transparency, community-driven development, and no vendor loc
6565

6666
## Quick Start
6767

68+
### Installation
69+
6870
Install OpenAdapt with the features you need:
6971

7072
```bash
7173
pip install openadapt[all] # Everything
7274
```
7375

74-
Collect a demonstration:
76+
**What You'll See:**
77+
```
78+
Successfully installed openadapt-1.0.0
79+
Successfully installed openadapt-capture-1.0.0
80+
Successfully installed openadapt-ml-1.0.0
81+
Successfully installed openadapt-evals-1.0.0
82+
...
83+
```
84+
85+
### Collect a Demonstration
7586

7687
```bash
7788
openadapt capture start --name my-task
7889
# Perform your task, then press Ctrl+C
7990
```
8091

81-
Learn a policy:
92+
**What You'll See:**
93+
```
94+
[INFO] Starting capture session: my-task
95+
[INFO] Recording started. Press Ctrl+C to stop.
96+
[INFO] Capturing events...
97+
^C
98+
[INFO] Capture stopped
99+
[INFO] Saved 127 events to database
100+
[SUCCESS] Capture 'my-task' completed successfully
101+
```
102+
103+
### Learn a Policy
82104

83105
```bash
84106
openadapt train start --capture my-task --model qwen3vl-2b
85107
```
86108

87-
Evaluate:
109+
**What You'll See:**
110+
```
111+
[INFO] Loading capture: my-task
112+
[INFO] Found 127 events
113+
[INFO] Initializing model: qwen3vl-2b
114+
[INFO] Starting training...
115+
Epoch 1/10: 100%|████████████| 127/127 [00:45<00:00]
116+
Epoch 2/10: 100%|████████████| 127/127 [00:43<00:00]
117+
...
118+
[SUCCESS] Training complete. Model saved to: training_output/model.pt
119+
```
120+
121+
### Evaluate
88122

89123
```bash
90124
openadapt eval run --checkpoint training_output/model.pt --benchmark waa
91125
```
92126

127+
**What You'll See:**
128+
```
129+
[INFO] Loading checkpoint: training_output/model.pt
130+
[INFO] Running benchmark: waa
131+
[INFO] Processing task 1/10...
132+
[INFO] Processing task 2/10...
133+
...
134+
[SUCCESS] Evaluation complete
135+
Results:
136+
Success Rate: 85.0%
137+
Average Steps: 12.3
138+
Total Time: 5m 32s
139+
```
140+
141+
**Success Indicators:**
142+
- Green checkmarks or `[SUCCESS]` messages indicate completion
143+
- No error or warning messages in the output
144+
- Output files created in expected locations
145+
- Metrics show reasonable values (success rate > 0%)
146+
93147
See the [Installation Guide](getting-started/installation.md) for detailed setup instructions.
94148

95149
---

0 commit comments

Comments
 (0)