Fix homepage: copy README to docs/index.md

Author: sun

docs/index.md

@@ -0,0 +1,123 @@
+# 🔬 Compileo: The Ultimate AI-Powered Document Processing & Dataset Engineering Suite
+
+**Compileo** is an enterprise-grade, modular platform designed to transform raw, unstructured data into high-quality, structured intelligence. Whether you're processing 1,000-page medical PDFs, scraping JavaScript-heavy websites, or engineering datasets for LLM fine-tuning and personal study, Compileo provides a unified, AI-driven lifecycle for the modern data era.
+
+---
+
+## 🌟 What can Compileo do?
+
+Compileo isn't just a parser—it's a comprehensive **data engineering ecosystem**. It automates the complex journey from \"Messy Source\" to \"Validated, Categorized Intelligence.\"
+
+### 📖 Multi-Source Knowledge Consolidation
+Imagine you have several thick textbooks and want to create a specialized dataset focused only on **disease treatments**. Compileo can:
+1.  **Ingest** all books simultaneously (PDF, DOCX, etc.).
+2.  **Discover** a unified \"Treatment\" taxonomy across all sources automatically.
+3.  **Extract** every mention of treatments, dosages, and contraindications with high precision.
+4.  **Consolidate** this into one unified, high-quality Q&A dataset for training or study.
+
+### 🕹️ Three Ways to Work
+Compileo is designed for every workflow:
+*   **Web GUI**: A user-friendly Streamlit interface with a 7-step guided wizard.
+*   **REST API**: Seamlessly integrate dataset generation into your own applications.
+*   **CLI**: Automate heavy-duty processing with powerful command-line parameters.
+
+---
+
+## 🚀 Impressive Features
+
+### 📄 Intelligent Document Processing & AI-Assisted Chunking
+*   **Massive PDF Autonomy**: Automatically splits 1,000+ page documents into manageable segments with **semantic overlaps**, ensuring LLM token limits are never hit while preserving context.
+*   **Two-Pass VLM Parsing**: Employs a \"Skim and Extract\" methodology using Vision-Language Models (Grok, Gemini, Ollama) to first understand document layout and then extract high-fidelity Markdown.
+*   **AI-Assisted Strategy Recommendation**: Don't guess how to split your data. Describe your goal (e.g., *\"I want to extract detailed surgical procedures\"*), and Compileo's AI will analyze your documents to recommend the optimal **Semantic**, **Token**, or **Schema-based** chunking strategy.
+
+### 🧠 Semantic Data Engineering
+*   **AI-Assisted Taxonomy**: Don't waste weeks defining categories. Compileo's **Smart Sampling** selects representative content to suggest and build hierarchical knowledge trees automatically.
+*   **Multi-Stage Extraction**: Performs **Hierarchical Classification**, moving from coarse-grained categories to fine-grained entities based on your custom or generated taxonomy.
+*   **Context-Aware NER**: Uses parent context during extraction to disambiguate entities and discover deep relationships between concepts.
+
+### 🧪 Advanced Quality Control & Evaluation
+*   **AI Confidence Scoring**: Every extracted entity and relationship is assigned an **AI confidence level** (0.0 - 1.0), allowing you to filter for only the most reliable data.
+*   **Deep Quality Metrics**: Automated scoring for **Lexical Diversity**, **Demographic Bias**, **Answer Coherence**, and **Target Audience Alignment** via the `datasetqual` module.
+*   **Fine-Tuned Model Testing**: Use the `benchmarking` module to evaluate how your **fine-tuned models** perform on your custom datasets using industry-standard metrics (Accuracy, F1, BLEU, ROUGE) and suites like GLUE or MMLU.
+
+### 🔌 Developer Extensibility
+*   **Robust Plugin System**: Effortlessly extend Compileo by adding custom **Ingestion Handlers**, **Dataset Formatters**, or **API Routers** via a simple `.zip` package architecture.
+*   **Custom Exports**: Out-of-the-box support for **Anki** export, allowing you to turn any technical document into a high-quality study deck.
+
+---
+
+## 🛠️ Installation
+
+### 🐳 Option 1: Docker
+The fastest way to deploy the full stack (API, GUI, and Redis).
+
+1.  **Clone & Prepare**:
+    ```bash
+    git clone https://github.com/your-org/compileo.git
+    cd compileo
+    cp .env.example .env  # Add your API keys for Gemini, Grok, etc.
+    ```
+2.  **Launch**:
+    ```bash
+    docker compose up --build -d
+    ```
+3.  **Access**:
+    *   **Web GUI**: `http://localhost:8501`
+    *   **API Docs**: `http://localhost:8000/docs`
+
+### 🔐 API Authentication & Security
+Compileo implements an **"Auto-Lock"** security model designed for zero-config startup without sacrificing security.
+
+*   **Unsecured Mode (Default)**: If no API keys are defined, Compileo allows all requests. This is ideal for first-time setup and local experimentation.
+*   **Secured Mode**: As soon as you define an API key, the system "locks" and strictly requires that key for all API and GUI operations.
+
+#### **How to Secure Your Instance (Choose One):**
+1.  **GUI (Recommended)**: Launch Compileo, go to **Settings > 🔗 API Configuration**, enter an **API Key**, and click **Save**. The system locks instantly.
+2.  **CLI**: Start the API with the `--api-key` flag:
+    ```bash
+    python -m src.compileo.api.main --api-key your_secret_key
+    ```
+3.  **Environment**: Define `COMPILEO_API_KEY=your_secret_key` in your `.env` or Docker configuration.
+
+#### **How to Connect to a Secured Instance:**
+All API requests must include the following header:
+```http
+X-API-Key: your_secret_key
+```
+
+---
+
+### 🐍 Option 2: Python Environment
+Ideal for local development, CLI automation, or custom integrations.
+
+**Prerequisites**: A running Redis server (`sudo apt install redis-server`).
+
+1.  **Setup Environment**:
+    ```bash
+    python -m venv .venv
+    source .venv/bin/activate  # Windows: .venv\Scripts\activate
+    ```
+2.  **Install Dependencies**:
+    ```bash
+    pip install -r requirements.txt
+    ```
+3.  **Start Services**:
+    ```bash
+    # 1. Start the API server (Optionally secure it with --api-key)
+    python -m src.compileo.api.main --api-key my_secret_token
+    
+    # 2. Start the Web GUI (In a new terminal)
+    streamlit run src/compileo/features/gui/main.py
+    ```
+    *Note: If you secured the API in step 1, you must enter the same key in the GUI Settings to connect.*
+
+---
+
+## 📖 Explore Further
+*   [API Authentication](docs/userGuide/api_authentication.md): Detailed guide on securing your Compileo API instance.
+*   [GUI User Guide](docs/userGuide/gui_user_guide.md): Walk through the 7-step Dataset Creation Wizard.
+*   [Plugin Development Guide](docs/developers/plugin_development_guide.md): Learn how to build your own extensions.
+*   [CLI Reference](docs/userGuide/documentscli.md): Automate workflows via the command line.
+
+## 📄 License
+[Insert License Information]

mkdocs.yml

@@ -45,7 +45,7 @@ docs_dir: docs
 site_dir: ../site
 
 nav:
-  - Home: ../README.md
+  - Home: index.md
   - User Guide:
       - API Authentication: docs/userGuide/api_authentication.md
       - Benchmarking API: docs/userGuide/benchmarkingapi.md