From a4e5dbc3e5c63c52d5f78088d39b7f253b94f18f Mon Sep 17 00:00:00 2001 From: BobAi Date: Fri, 15 Aug 2025 09:55:36 +1000 Subject: [PATCH] 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 --- README.md | 43 ++++++++++++++++++++++++++++++++----------- 1 file changed, 32 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ee5fc30..ab8a043 100644 --- a/README.md +++ b/README.md @@ -12,19 +12,40 @@ ## How It Works ```mermaid -graph LR - Files[📁 Your Code/Documents] --> Index[🔍 Index] - Index --> Chunks[✂️ Smart Chunks] - Chunks --> Embeddings[🧠 Semantic Vectors] - Embeddings --> Database[(💾 Vector DB)] +flowchart TD + Start([🚀 Start FSS-Mini-RAG]) --> Interface{Choose Interface} - Query[❓ user auth] --> Search[🎯 Hybrid Search] - Database --> Search - Search --> Results[📋 Ranked Results] + Interface -->|Beginners| TUI[🖥️ Interactive TUI
./rag-tui] + Interface -->|Power Users| CLI[⚡ Advanced CLI
./rag-mini ] - style Files fill:#e3f2fd - style Results fill:#e8f5e8 - style Database fill:#fff3e0 + TUI --> SelectFolder[📁 Select Folder to Index] + CLI --> SelectFolder + + SelectFolder --> Index[🔍 Index Documents
Creates searchable database] + + Index --> Ready{📚 Ready to Search} + + Ready -->|Quick Answers| Search[🔍 Search Mode
Fast semantic search] + Ready -->|Deep Analysis| Explore[🧠 Explore Mode
AI-powered analysis] + + Search --> SearchResults[📋 Instant Results
Ranked by relevance] + Explore --> ExploreResults[💬 AI Conversation
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:
• Batch processing
• Custom parameters
• Automation scripts
• 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