Skip to content

Commit 444353c

Browse files
committed
Update README with RAG system details and setup
Expanded the AI Tools section to highlight RAG (Retrieval-Augmented Generation) features, including context-aware answers and document embeddings. Added setup instructions for enabling RAG, quick start steps, and new documentation links. Clarified production deployment steps to include Supabase and knowledge base indexing. Enhanced feature lists to reflect RAG capabilities and updated environment variable configuration.
1 parent 074e5e2 commit 444353c

1 file changed

Lines changed: 53 additions & 8 deletions

File tree

README.md

Lines changed: 53 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -270,20 +270,32 @@ The build step runs Next.js static analysis, type-checking, and route bundling.
270270

271271
## AI Tools
272272

273-
The **AI Tools** feature (`/dashboard/ai-tools`) provides an intelligent development assistant running 100% locally with Ollama.
273+
The **AI Tools** feature (`/dashboard/ai-tools`) provides an intelligent development assistant with **RAG (Retrieval-Augmented Generation)** - AI that knows your platform inside-out!
274274

275275
### Features
276276

277+
- **🧠 RAG-Enhanced AI** – AI powered by your documentation, features, and codebase
277278
- **🤖 Smart AI Assistant** – Code generation, debugging, architecture decisions, and technical guidance
278-
- **🔒 Complete Privacy** – All processing happens on your machine, zero data sent to cloud
279-
- **💰 Zero Cost** – No API fees, unlimited usage
279+
- **📚 Context-Aware** – Answers based on your actual platform documentation
280+
- **🔒 Complete Privacy** – All processing and data stays on your infrastructure
281+
- **💰 Zero Cost** – No API fees, unlimited usage with local Ollama
280282
- **🌐 Offline Capable** – Works without internet connection
281283
- **💬 Modern Chat UI** – User/AI avatars, message bubbles, copy-to-clipboard, typing indicators
282-
- **📊 Real-time Status** – Shows Ollama connection status
284+
- **📊 Real-time Status** – Shows Ollama connection status and RAG usage
283285
- **🧹 Clear Chat** – Reset conversation anytime
284286
- **📝 Message Counter** – Track conversation length and character count
285287

286-
### Setup
288+
### What is RAG?
289+
290+
**RAG (Retrieval-Augmented Generation)** combines semantic search with AI generation:
291+
292+
1. **Your Question** → Converted to embedding vector
293+
2. **Vector Search** → Finds relevant docs from your knowledge base
294+
3. **AI Generation** → Ollama uses the context to answer accurately
295+
296+
**Result:** AI that actually knows your platform, features, and documentation!
297+
298+
### Quick Start
287299

288300
#### 1. Install Ollama
289301

@@ -305,25 +317,52 @@ ollama pull codellama # Code-specialized (3.8GB)
305317
ollama pull qwen2.5-coder:7b # Excellent for programming
306318
```
307319

308-
#### 3. Start Using
320+
#### 3. Enable RAG System
321+
322+
See **[docs/RAG_QUICKSTART.md](docs/RAG_QUICKSTART.md)** for setup:
323+
324+
```powershell
325+
# 1. Run SQL schema in Supabase
326+
# 2. Index your knowledge base
327+
pnpm run index-knowledge
328+
329+
# 3. Test it!
330+
# Visit http://localhost:3000/dashboard/ai-tools
331+
```
332+
333+
#### 4. Start Using
309334

310335
```powershell
311336
pnpm dev
312337
# Navigate to http://localhost:3000/dashboard/ai-tools
313338
```
314339

315-
See [docs/OLLAMA_SETUP.md](docs/OLLAMA_SETUP.md) for detailed setup instructions.
340+
See [docs/OLLAMA_SETUP.md](docs/OLLAMA_SETUP.md) for detailed Ollama setup.
341+
See [docs/RAG_SYSTEM.md](docs/RAG_SYSTEM.md) for complete RAG documentation.
342+
343+
### RAG Features
344+
345+
- **📄 Document Embeddings** – All docs indexed with semantic vectors
346+
- **🔍 Smart Search** – Finds relevant content via cosine similarity
347+
- **⚡ Fast Retrieval** – < 10ms search with pgvector indexes
348+
- **🎯 Category Filtering** – Search by documentation, features, code, etc.
349+
- **🔄 Easy Updates** – Re-index when docs change
350+
- **📊 Similarity Scores** – See how relevant each context is
316351

317352
### Production Deployment
318353

319354
For production, run Ollama on a separate server:
320355

321356
1. **Deploy Next.js** on Vercel (or any platform)
322357
2. **Setup Ollama server** on VPS (AWS EC2, DigitalOcean, Hetzner)
323-
3. **Configure environment variable:**
358+
3. **Configure Supabase** with pgvector extension
359+
4. **Run indexer** to populate knowledge base
360+
5. **Set environment variables:**
324361

325362
```env
326363
OLLAMA_URL=https://ai.yourdomain.com
364+
NEXT_PUBLIC_SUPABASE_URL=your-supabase-url
365+
NEXT_PUBLIC_SUPABASE_ANON_KEY=your-anon-key
327366
```
328367

329368
**Benefits:**
@@ -333,7 +372,11 @@ For production, run Ollama on a separate server:
333372
- ✅ Unlimited usage - no rate limits or quotas
334373
- ✅ Fast responses - no network latency (with good hardware)
335374
- ✅ Full control - choose any model, customize parameters
375+
- ✅ Platform-specific knowledge - AI trained on YOUR docs
376+
377+
---
336378

379+
<<<<<<< Updated upstream
337380
--- ```bash
338381

339382
# Add to Vercel environment variables
@@ -363,6 +406,8 @@ The AI tries providers in this order:
363406
364407
---
365408
409+
=======
410+
>>>>>>> Stashed changes
366411
## Feature Overview
367412
368413
| Area | Summary |

0 commit comments

Comments
 (0)