Add Writecream, X0GPT, and Zenmux providers with chat completion functionality

- Implemented Writecream provider with support for chat completions, including streaming and non-streaming responses.
- Added X0GPT provider with a comprehensive chat completion system, handling both streaming and non-streaming requests.
- Developed Zenmux provider, integrating chat completion capabilities and handling tool calls.
- Each provider includes error handling, token counting, and response formatting to ensure compatibility with existing interfaces.

Signed-off-by: OEvortex <[email protected]>

Author: OEvortex

.github/workflows/deploy-docs.yml

@@ -0,0 +1,96 @@
+name: Deploy Documentation to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+      - new-providers
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - '.github/workflows/deploy-docs.yml'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs mkdocs-material pymdown-extensions
+
+      - name: Build documentation
+        run: mkdocs build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: 'site'
+
+  deploy:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
+
+  test-pr:
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs mkdocs-material pymdown-extensions
+
+      - name: Build documentation (test)
+        run: mkdocs build
+
+      - name: Check for build errors
+        run: |
+          if [ ! -d "site" ]; then
+            echo "❌ Documentation build failed!"
+            exit 1
+          fi
+          echo "✅ Documentation built successfully!"

Provider.md

@@ -230,7 +230,7 @@ provider = Groq()
 response = provider.chat("Hello, how are you?")
 
 # OpenAI-Compatible Provider
-from webscout.Provider.OPENAI import groq
+from webscout.Provider.Openai_comp import groq
 client = groq.GroqProvider()
 response = client.chat.completions.create(
     model="mixtral-8x7b",

changelog.md

@@ -2,7 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
-## [2026.01.23] - 2026-01-23
+## [2026.01.24] - 2026-01-24
+
+### Renamed
+- **rename**: webscout/Provider/OPENAI → webscout/Provider/Openai_comp - Renamed OPENAI directory to Openai_comp for better clarity and consistency with naming conventions.
 
 ### 🚮 Removed
 - **move**: webscout/Provider/AISEARCH/brave_search.py → webscout/Provider/UNFINISHED/brave_search.py - Moved BraveAI provider to UNFINISHED folder. The Brave Search AI Chat API (/api/tap/v1/new endpoint) currently returns 404 errors despite correct reverse-engineering and parameter handling. Requires further investigation into API authentication or endpoint changes.

docs/README.md

@@ -4,6 +4,11 @@
 
 Welcome to the central entry point for everything you need to know about Webscout. This hub is organized around the actual modules that live inside the repository so you can quickly jump from high-level concepts to concrete implementation details.
 
+## 📚 **[Complete Documentation Index →](DOCUMENTATION_INDEX.md)**
+*Navigate all docs, find learning paths, search by use case, and get started quickly!*
+
+---
+
 ## 🔗 Quick Navigation
 
 | Topic | Why it matters | Primary Reference |