feat(docs): Enhance documentation and configuration for improved usability

- Updated `mkdocs.yml` to refine site navigation and add an edit URI for easier access to documentation editing.
- Enhanced theme features in `mkdocs.yml` to include sticky tabs, tooltips, and improved navigation elements.
- Revised `README.md` to include performance metrics and benchmarking instructions, providing users with clearer guidance on system capabilities.
- Improved `playwright.config.ts` to utilize environment variables for base URLs, enhancing flexibility in testing configurations.
- Updated Grafana dashboard configurations to improve observability metrics and ensure accurate data representation.
- Removed outdated `deploy.md` file to streamline documentation and focus on current deployment practices.

These changes significantly enhance the clarity, accessibility, and usability of the TriBridRAG documentation, making it easier for users to navigate and understand the system's features.

Author: DMontgomery40

.github/workflows/deploy-docs.yml

@@ -41,16 +41,18 @@ jobs:
 
       - name: Install dependencies
         run: |
-          pip install mkdocs mkdocs-material mkdocs-glightbox mike
-          pip install openai  # For docs regeneration
+          python -m pip install --upgrade pip
+          pip install mkdocs==1.6.1 mkdocs-material==9.7.1 pymdown-extensions==10.7.1
+          pip install mike==2.1.0 mkdocs-git-revision-date-localized-plugin==1.2.6 mkdocs-minify-plugin==0.8.0
+          pip install mkdocs-glightbox openai requests pyyaml  # For docs regeneration
 
       - name: Regenerate docs with AI (optional)
         if: ${{ github.event.inputs.regenerate_docs == 'true' }}
         env:
           OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
         run: |
           echo "Regenerating documentation using AI..."
-          python scripts/docs_ai/bootstrap_docs.py --all --model gpt-4o
+          python scripts/docs_ai/docs_autopilot_enhanced.py --regenerate-all
 
           # Commit regenerated docs
           git config user.name "github-actions[bot]"

.github/workflows/docs-automation.yml

@@ -33,9 +33,11 @@ jobs:
 
       - name: Install dependencies
         run: |
-          pip install mkdocs mkdocs-material pymdown-extensions
-          pip install requests pyyaml
-          pip install mkdocs-git-revision-date-localized-plugin mkdocs-minify-plugin
+          python -m pip install --upgrade pip
+          pip install mkdocs==1.6.1 mkdocs-material==9.7.1 pymdown-extensions==10.7.1
+          pip install mike==2.1.0 mkdocs-git-revision-date-localized-plugin==1.2.6 mkdocs-minify-plugin==0.8.0
+          pip install mkdocs-glightbox
+          pip install requests pyyaml openai
 
       - name: Generate documentation with AI
         if: ${{ github.event.inputs.regenerate_all == 'true' }}
@@ -45,7 +47,7 @@ jobs:
           python scripts/docs_ai/docs_autopilot_enhanced.py --regenerate-all
 
       - name: Build documentation
-        run: mkdocs build
+        run: mkdocs build --strict
 
       - name: Create PR with documentation updates
         if: github.event_name == 'workflow_dispatch' && github.event.inputs.regenerate_all == 'true'
@@ -85,11 +87,13 @@ jobs:
 
       - name: Install dependencies
         run: |
-          pip install mkdocs mkdocs-material pymdown-extensions
-          pip install mkdocs-git-revision-date-localized-plugin mkdocs-minify-plugin
+          python -m pip install --upgrade pip
+          pip install mkdocs==1.6.1 mkdocs-material==9.7.1 pymdown-extensions==10.7.1
+          pip install mike==2.1.0 mkdocs-git-revision-date-localized-plugin==1.2.6 mkdocs-minify-plugin==0.8.0
+          pip install mkdocs-glightbox
 
       - name: Build documentation
-        run: mkdocs build
+        run: mkdocs build --strict
 
       - name: Setup Pages
         uses: actions/configure-pages@v4

README.md

@@ -86,6 +86,49 @@ Each search method compensates for the others' weaknesses. The result: **dramati
 
 ---
 
+## Performance
+
+TriBridRAG measures real pipeline latency and throughput via **Prometheus + Grafana** (see dashboards `tribrid-overview` and `tribrid-rag-metrics`). For reproducible local benchmarking (index + search), use the built-in benchmark runner.
+
+### Reproducible benchmark (index + search)
+
+Prereqs:
+
+```bash
+docker compose up -d postgres neo4j
+# If using the docker-compose defaults:
+export NEO4J_PASSWORD=password
+```
+
+Run:
+
+```bash
+uv run scripts/benchmark_perf.py --corpus-id tribrid-rag --corpus-path . --force-reindex --iterations 5 --warmup 1
+```
+
+This prints **Markdown + JSON** summary you can paste into docs/PRs.
+
+### Latest benchmark (local dev run)
+
+Generated on `2026-02-01` with the command above (vector+sparse+graph enabled, `final_k=10`).
+
+| Operation | Performance | Notes |
+|---|---:|---|
+| Indexing | 419.0s | 497 files, 8,753 chunks, 702,647 tokens |
+| Search (tri-brid) | p50 459ms, p95 487ms | 25 calls (5 queries × 5 iters), ~1.62 QPS |
+
+Per-query (ms):
+
+| Query | p50 | p95 | mean |
+|---|---:|---:|---:|
+| authentication flow | 373.5 | 758.5 | 449.6 |
+| prometheus metrics endpoint /metrics | 462.5 | 484.9 | 466.5 |
+| neo4j graph retrieval mode | 461.6 | 487.1 | 467.5 |
+| where is /api/search implemented | 449.4 | 458.7 | 450.0 |
+| fusion rrf_k parameter | 471.0 | 483.0 | 465.9 |
+
+---
+
 ## Quick Start
 
 ### Prerequisites
@@ -528,7 +571,7 @@ cd web && npx playwright test
 | Service | URL | Credentials |
 |---------|-----|-------------|
 | API Docs | http://localhost:8012/docs | - |
-| Grafana | http://localhost:3000 | admin/admin |
+| Grafana | http://localhost:3001 | admin/admin |
 | Prometheus | http://localhost:9090 | - |
 | Neo4j Browser | http://localhost:7474 | neo4j/password |