checking changes

README.md

@@ -1,95 +1,79 @@
-# OpenTriage AI Engine - Full Backend
+---
+title: OpenTriage AI Engine
+emoji: 🧠
+colorFrom: purple
+colorTo: pink
+sdk: docker
+app_port: 7860
+pinned: false
+---
 
-Full-featured AI backend for OpenTriage, lifted directly from the original Python codebase.
+# 🧠 OpenTriage AI Engine (Microservice)
 
-## Features
+This is the **AI Brain** of the OpenTriage platform. It is a specialized Python microservice acting as a "Sidecar" to the main TypeScript backend.
 
-- **Issue Triage** - AI-powered classification and labeling
-- **RAG Chatbot** - Repository-aware Q&A using retrieval-augmented generation  
-- **Mentor Matching** - Tech stack-based mentor recommendations
-- **Hype Generator** - Celebration messages for PRs
-- **AI Chat** - General assistance for contributors
+It hosts the heavy-lifting AI logic, including RAG (Retrieval-Augmented Generation), Issue Triage, and Mentor Matching, keeping the main application fast and lightweight.
 
-## API Endpoints
+## 🚀 Features
 
-| Endpoint | Method | Description |
-|----------|--------|-------------|
-| `/health` | GET | Health check |
-| `/triage` | POST | Issue classification |
-| `/chat` | POST | AI chat assistant |
-| `/rag/chat` | POST | RAG-based Q&A |
-| `/rag/index` | POST | Index repository for RAG |
-| `/rag/suggestions` | GET | Suggested questions |
-| `/mentor-match` | POST | Find mentor matches |
-| `/hype` | POST | Generate PR celebration |
-| `/rag/prepare` | POST | Prepare RAG documents |
-| `/rag/chunks` | GET | Get chunks for embedding |
+* **🔍 AI Triage:** Automatically classifies GitHub issues by complexity and type.
+* **📚 RAG Chatbot:** "Chat with Repo" functionality using vector search.
+* **🤝 Mentor Match:** Connects contributors to mentors based on tech stack analysis.
+* **🎉 Hype Generator:** Generates celebratory messages for PR merges.
 
-## Quick Start
+---
 
-### Local Development
+## 🔗 How to Connect
 
-```bash
-# Create virtual environment
-python -m venv venv
-source venv/bin/activate
+This service exposes a REST API via **FastAPI**. It is designed to be called by the Main Backend, not directly by users.
 
-# Install dependencies
-pip install -r requirements.txt
+### Base URL
+Your API is live at:
+`https://[YOUR_USERNAME]-opentriage-ai-engine.hf.space`
+
+*(Check the "Embed this space" menu in the top right to get your exact direct URL)*
+
+### API Endpoints
+
+| Method | Endpoint | Description |
+| :--- | :--- | :--- |
+| `GET` | `/health` | Server health check (returns 200 OK) |
+| `POST` | `/triage` | Classifies an issue description |
+| `POST` | `/chat` | General AI assistant response |
+| `POST` | `/rag/chat` | Context-aware repository Q&A |
+| `POST` | `/mentor-match` | Finds best matching mentors |
+
+---
+
+## 🛠 Deployment Configuration
 
-# Set environment variables
-export OPENROUTER_API_KEY=your_key_here
+### 1. Environment Variables (Secrets)
+You must set these in the **Settings** tab of this Space under "Variables and secrets":
 
-# Run the server
-python main.py
-```
+| Secret Name | Required? | Description |
+| :--- | :--- | :--- |
+| `OPENROUTER_API_KEY` | **Yes** | Required for all AI generation |
+| `MONGO_URL` | Optional | If your RAG needs persistent vector storage |
 
-### Docker
+### 2. Docker Configuration
+This Space uses a custom Dockerfile to ensure all Python scientific libraries (NumPy, Scikit-learn, LangChain) are installed in a compatible environment.
+
+* **Port:** 7860 (Standard HF Space port)
+* **User:** Runs as non-root user `user` (ID 1000) for security.
+
+---
+
+## 💻 Local Development
+
+If you want to run this brain locally:
 
 ```bash
-docker build -t opentriage-ai-engine .
-docker run -p 7860:7860 -e OPENROUTER_API_KEY=your_key opentriage-ai-engine
-```
-
-## Hugging Face Spaces Deployment
-
-1. Create a new Space (Docker SDK)
-2. Add secrets in Space settings:
-   - `OPENROUTER_API_KEY` (required)
-   - `MONGO_URL` (optional, for DB features)
-3. Push this folder to the Space
-
-The Dockerfile is pre-configured for HF Spaces (non-root user, port 7860).
-
-## Environment Variables
-
-| Variable | Required | Description |
-|----------|----------|-------------|
-| `OPENROUTER_API_KEY` | Yes | OpenRouter API key |
-| `MONGO_URL` | No | MongoDB connection string |
-| `FRONTEND_URL` | No | Frontend URL for CORS |
-| `CORS_ORIGINS` | No | Comma-separated CORS origins |
-| `ENVIRONMENT` | No | `development` or `production` |
-
-## Architecture
-
-```
-ai-engine/
-├── main.py              # FastAPI wrapper (new)
-├── Dockerfile           # HF-compliant Docker config
-├── requirements.txt     # Python dependencies
-├── config/
-│   └── settings.py      # Environment configuration
-├── models/              # Pydantic models (original)
-├── services/            # AI services (original, unchanged)
-│   ├── ai_service.py
-│   ├── rag_chatbot_service.py
-│   ├── mentor_matching_service.py
-│   ├── hype_generator_service.py
-│   └── rag_data_prep.py
-└── utils/               # Utilities (original)
-```
-
-## License
-
-MIT - See parent repository LICENSE file.
+# 1. Create venv
+python -m venv venv
+source venv/bin/activate
+
+# 2. Install
+pip install -r requirements.txt
+
+# 3. Run
+uvicorn main:app --reload --port 8000