added docs

Author: OMCHOKSI108

.github/workflows/deploy-mkdocs.yml

@@ -0,0 +1,57 @@
+name: Deploy MkDocs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main  # Change this to your default branch name
+  workflow_dispatch:  # Allow manual triggering
+
+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
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs mkdocs-material
+
+      - name: Build MkDocs site
+        run: mkdocs build
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './site'
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -38,6 +38,7 @@ jspm_packages/
 
 # Output of 'npm pack'
 *.tgz
+.venv
 
 # Yarn Integrity file
 .yarn-integrity

POSTMAN/DevOverflow_Environment.postman_environment.json

@@ -0,0 +1,19 @@
+{
+    "id": "devoverflow-env",
+    "name": "DevOverflow Backend Environment",
+    "values": [
+        {
+            "key": "base_url",
+            "value": "http://localhost:3000",
+            "description": "Base URL for the DevOverflow backend API",
+            "enabled": true
+        },
+        {
+            "key": "jwt_token",
+            "value": "",
+            "description": "JWT token obtained from login/register endpoint",
+            "enabled": true
+        }
+    ],
+    "_postman_variable_scope": "environment"
+}

docs/AI_APIS_POSTMAN_GUIDE.txt

@@ -13,7 +13,9 @@ PREREQUISITES
 1. Start the backend server: `npm start`
 2. Get JWT token by logging in via POST /api/auth/login
 3. Set Authorization header: `Bearer YOUR_JWT_TOKEN`
-4. Ensure GEMINI_API_KEY is configured in .env
+4. Ensure GEMINI_API_KEY is configured in .env (tested and working)
+5. For development/testing without API calls, set AI_MOCK=true in .env
+6. Optional: Set GEMINI_MODEL to pin a specific model (defaults to fallback candidates)
 
 ================================================================================
 AI ENDPOINTS TESTING GUIDE

docs/DEPLOYMENT_GUIDE.md

@@ -0,0 +1,93 @@
+# Deploy MkDocs to GitHub Pages - Manual Method
+
+## Step 1: Enable GitHub Pages
+1. Go to your repository on GitHub
+2. Click on **Settings** tab
+3. Scroll down to **Pages** section
+4. Under **Source**, select **Deploy from a branch**
+5. Select **gh-pages** branch and **/(root)** folder
+6. Click **Save**
+
+## Step 2: Build and Deploy Manually
+
+### Option A: Using GitHub Actions (Recommended)
+The workflow file `.github/workflows/deploy-mkdocs.yml` has been created for you.
+
+**To trigger deployment:**
+1. Commit and push the workflow file to your main branch
+2. Go to **Actions** tab in your repository
+3. Click on the **Deploy MkDocs to GitHub Pages** workflow
+4. Click **Run workflow**
+
+### Option B: Manual Deployment Script
+
+Create a deployment script:
+
+```bash
+#!/bin/bash
+# deploy.sh
+
+# Build the site
+mkdocs build
+
+# Create gh-pages branch if it doesn't exist
+git checkout --orphan gh-pages
+git reset --hard
+
+# Copy built site files
+cp -r site/* .
+rm -rf site/
+
+# Add and commit
+git add .
+git commit -m "Deploy MkDocs site"
+
+# Push to gh-pages branch
+git push origin gh-pages --force
+
+# Go back to main branch
+git checkout main
+```
+
+Make it executable and run:
+```bash
+chmod +x deploy.sh
+./deploy.sh
+```
+
+## Step 3: Access Your Site
+
+After deployment, your site will be available at:
+```
+https://YOUR_USERNAME.github.io/YOUR_REPOSITORY_NAME/
+```
+
+For example:
+```
+https://omchoksi108.github.io/Devoverflow-Backend/
+```
+
+## Step 4: Custom Domain (Optional)
+
+To use a custom domain:
+1. Go to repository **Settings** → **Pages**
+2. Under **Custom domain**, enter your domain
+3. Add a `CNAME` file to your `docs/` directory with your domain name
+4. Configure DNS settings with your domain provider
+
+## Troubleshooting
+
+### Site not updating?
+- Wait 2-3 minutes after deployment
+- Check the **Actions** tab for any build errors
+- Clear your browser cache
+
+### Build failing?
+- Check the MkDocs configuration in `mkdocs.yml`
+- Ensure all required dependencies are installed
+- Verify file paths in navigation are correct
+
+### 404 errors?
+- Make sure GitHub Pages is enabled
+- Check that the `gh-pages` branch exists
+- Verify the build output is in the correct location

docs/GEMINI_API_SETUP.md

@@ -1,12 +1,13 @@
 # 🔑 Gemini API Setup Guide
 
-## Why AI Failed
+## ✅ Current Status: Keys Tested and Working
 
-Your Gemini API keys are **invalid/expired**. The system shows:
-- ❌ Primary key: "API key not valid"
--- ❌ Backup key: "models/<model> is not found" — check GET /api/ai/status for the model the server is attempting to use, or set GEMINI_MODEL to a supported model name.
+Your Gemini API keys have been tested and are operational. The system shows:
+- ✅ Primary key: Valid and working
+- ✅ Backup key: Available for fallback
+- ✅ Model fallback: Automatic model selection with candidates
 
-## 🚀 How to Get Valid Gemini API Keys
+## 🚀 How to Get Valid Gemini API Keys (If Needed)
 
 ### Step 1: Visit Google AI Studio
 1. Go to: https://makersuite.google.com/app/apikey
@@ -49,6 +50,10 @@ node demonstrateMemory.js
 - **Backup key**: Automatic fallback if primary fails
 - **Error handling**: Graceful degradation
 
+### ✅ Development Mode
+- **AI_MOCK=true**: Use deterministic mock responses for testing without API calls
+- **GEMINI_MODEL**: Pin a specific model (optional, defaults to fallback candidates)
+
 ### ✅ Indian Developer Focus
 - **Context-aware responses** for Indian tech ecosystem
 - **Local market insights** (jobs, frameworks, trends)