Improve README workflow diagram to show actual user journey
- Replace generic technical diagram with user-focused workflow - Show clear path from start to results via TUI or CLI - Highlight CLI advanced features to encourage power user adoption - Demonstrate the two core modes: Search (fast) vs Explore (deep) - Visual emphasis on CLI power and advanced capabilities
This commit is contained in:
parent
c201b3badd
commit
a4e5dbc3e5
43
README.md
43
README.md
@ -12,19 +12,40 @@
|
|||||||
## How It Works
|
## How It Works
|
||||||
|
|
||||||
```mermaid
|
```mermaid
|
||||||
graph LR
|
flowchart TD
|
||||||
Files[📁 Your Code/Documents] --> Index[🔍 Index]
|
Start([🚀 Start FSS-Mini-RAG]) --> Interface{Choose Interface}
|
||||||
Index --> Chunks[✂️ Smart Chunks]
|
|
||||||
Chunks --> Embeddings[🧠 Semantic Vectors]
|
|
||||||
Embeddings --> Database[(💾 Vector DB)]
|
|
||||||
|
|
||||||
Query[❓ user auth] --> Search[🎯 Hybrid Search]
|
Interface -->|Beginners| TUI[🖥️ Interactive TUI<br/>./rag-tui]
|
||||||
Database --> Search
|
Interface -->|Power Users| CLI[⚡ Advanced CLI<br/>./rag-mini <command>]
|
||||||
Search --> Results[📋 Ranked Results]
|
|
||||||
|
|
||||||
style Files fill:#e3f2fd
|
TUI --> SelectFolder[📁 Select Folder to Index]
|
||||||
style Results fill:#e8f5e8
|
CLI --> SelectFolder
|
||||||
style Database fill:#fff3e0
|
|
||||||
|
SelectFolder --> Index[🔍 Index Documents<br/>Creates searchable database]
|
||||||
|
|
||||||
|
Index --> Ready{📚 Ready to Search}
|
||||||
|
|
||||||
|
Ready -->|Quick Answers| Search[🔍 Search Mode<br/>Fast semantic search]
|
||||||
|
Ready -->|Deep Analysis| Explore[🧠 Explore Mode<br/>AI-powered analysis]
|
||||||
|
|
||||||
|
Search --> SearchResults[📋 Instant Results<br/>Ranked by relevance]
|
||||||
|
Explore --> ExploreResults[💬 AI Conversation<br/>Context + reasoning]
|
||||||
|
|
||||||
|
SearchResults --> More{Want More?}
|
||||||
|
ExploreResults --> More
|
||||||
|
|
||||||
|
More -->|Different Query| Ready
|
||||||
|
More -->|Advanced Features| CLI
|
||||||
|
More -->|Done| End([✅ Success!])
|
||||||
|
|
||||||
|
CLI -.->|Full Power| AdvancedFeatures[⚡ Advanced Features:<br/>• Batch processing<br/>• Custom parameters<br/>• Automation scripts<br/>• Background server]
|
||||||
|
|
||||||
|
style Start fill:#e3f2fd
|
||||||
|
style CLI fill:#fff3e0,stroke:#ff9800,stroke-width:3px
|
||||||
|
style AdvancedFeatures fill:#fff3e0,stroke:#ff9800,stroke-width:2px
|
||||||
|
style Search fill:#e8f5e8
|
||||||
|
style Explore fill:#f3e5f5
|
||||||
|
style End fill:#e8f5e8
|
||||||
```
|
```
|
||||||
|
|
||||||
## What This Is
|
## What This Is
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user