Skip to content

Commit d3322ae

Browse files
committed
docs: Fix linting issues and sync manual improvements
1 parent 3301b4b commit d3322ae

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,13 @@ Lawnmower Man is a production-grade **Model Context Protocol (MCP)** Gateway tha
2626
The v2.0.0 release introduces a professional "Glassmorphism" dashboard for managing your forensic lab.
2727

2828
### 🔌 Connections Manager
29+
2930
- **Dynamic AI Strategy**: Switch between Langflow (Hybrid), Ollama (Local), or Mock providers on the fly.
3031
- **Service Health**: Real-time status indicators for all infrastructure components.
3132
- **Hardware Telemetry**: Live CPU, RAM, and VRAM monitoring.
3233

3334
### 🕸️ The Harvester Panel
35+
3436
- **Semantic Scraper**: Convert any URL into LLM-ready markdown.
3537
- **Recursive Deep Crawl**: Map entire domains for forensic analysis.
3638
- **JS Rendering**: Support for heavy Single Page Applications (SPA).
@@ -62,25 +64,29 @@ graph TD
6264
## 🚀 Deployment
6365

6466
### Docker (Recommended)
67+
6568
The easiest way to get started is using the unified container stack:
6669

6770
```bash
6871
docker-compose up --build
6972
```
7073

7174
This starts:
75+
7276
- `sme-operator`: Core logic (Port 8000)
7377
- `sme-sidecar`: AI bridge (Port 8089)
7478
- `sme-frontend`: Control Room UI (Port 5173)
7579

7680
### Local Manual Start
81+
7782
1. **Operator**: `python -m src.api.main`
7883
2. **Sidecar**: `python -m src.ai.sidecar`
7984
3. **Frontend**: `cd frontend && npm run dev`
8085

8186
---
8287

8388
## 🛠️ Utility Suite
89+
8490
...
8591

8692
Our lightweight utility tools are optimized for the NVIDIA GeForce GTX 1660 Ti 6GB VRAM constraints:

docs/ADVANCED_QUICKSTART.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ pip install -r requirements.txt
2727
python validate_toolbox.py
2828
```
2929

30-
**Optional: Verify specific dependencies**
30+
### Optional: Verify specific dependencies
31+
3132
```bash
3233
python -c "from echo_transcriber import check_transcription_dependencies"
3334
```
@@ -121,14 +122,16 @@ streamlit run beacon_dashboard.py
121122
```
122123

123124
**Then:**
124-
1. Open http://localhost:8501 in browser
125+
126+
1. Open <http://localhost:8501> in browser
125127
2. Use sidebar to select mode:
126128
- **Trends:** Sentiment over time
127129
- **Pharos:** Escalation prediction
128130
- **Foundations:** Moral foundation heatmap
129131
- **Alerts:** Real-time warnings
130132

131133
**What to look for:**
134+
132135
- 🔴 Red alert = escalation detected
133136
- 📈 Spikes > 1.5σ = rhetoric spike
134137
- Upward trend = concerning pattern
@@ -270,19 +273,22 @@ else:
270273
## 🛠️ Troubleshooting
271274

272275
### Echo: FFmpeg not found
276+
273277
```bash
274278
# Windows: Download from https://ffmpeg.org/download.html
275279
# macOS: brew install ffmpeg
276280
# Linux: sudo apt install ffmpeg
277281
```
278282

279283
### Echo: CUDA out of memory
284+
280285
```python
281286
# Use smaller model instead of medium
282287
transcribe_youtube_url(url, model_size="base") # or "small"
283288
```
284289

285290
### Beacon: Can't connect to dashboard
291+
286292
```bash
287293
# Make sure Streamlit is installed
288294
pip install streamlit
@@ -292,6 +298,7 @@ streamlit run beacon_dashboard.py --server.port 8501
292298
```
293299

294300
### Curator: Signals not updating
301+
295302
```bash
296303
# Check file permissions
297304
import os
@@ -305,7 +312,7 @@ print(f"Writable: {os.access(signals_path, os.W_OK)}")
305312
## 📊 Performance Expectations
306313

307314
| Operation | Time | Notes |
308-
|-----------|------|-------|
315+
| :--- | :--- | :--- |
309316
| YouTube transcribe (1hr) | 5-10 min | Model: medium, 1660 Ti |
310317
| Loom distillation | <1 sec | For transcripts |
311318
| Beacon dashboard load | <5 sec | First time loads model |
@@ -317,18 +324,21 @@ print(f"Writable: {os.access(signals_path, os.W_OK)}")
317324
## 🎯 Best Practices
318325

319326
### Curator
327+
320328
- ✅ Start with `strength=0.5` (conservative)
321329
- ✅ Review suggestions before bulk calibration
322330
- ✅ Keep calibration log backed up
323331
- ✅ Check stats weekly
324332

325333
### Beacon
334+
326335
- ✅ Monitor Pharos alerts for escalation
327336
- ✅ Export snapshots for reports
328337
- ✅ Adjust spike threshold if needed
329338
- ✅ Watch for foundation distribution changes
330339

331340
### Echo
341+
332342
- ✅ Check dependencies before batch
333343
- ✅ Use `model_size="medium"` for balance
334344
- ✅ Transcribe during low-GPU periods
@@ -359,11 +369,13 @@ docker-compose up --build
359369
```
360370

361371
**Accessing the Dashboard:**
372+
362373
1. Open [http://localhost:5173](http://localhost:5173)
363374
2. **Connections Tab**: Monitor Sidecar and Database health. Switch AI providers dynamically.
364375
3. **Harvester Tab**: Ingest new web content by providing a URL.
365376

366377
**Harvester Features:**
378+
367379
-**JS Render**: Enable for React/Next.js sites.
368380
-**Deep Crawl**: Enable recursive mapping of domain subpages.
369381
-**Report**: View word count, quality scores, and raw markdown capture.
@@ -381,6 +393,7 @@ docker-compose up --build
381393
## 🎉 Summary
382394

383395
**3 new advanced tools:**
396+
384397
- 🎯 **Curator:** Closed-loop learning
385398
- 📊 **Beacon:** Predictive monitoring
386399
- 🎙️ **Echo:** Audio transcription

0 commit comments

Comments
 (0)