mkdocs.yml

# SPDX-License-Identifier: AGPL-3.0-or-later
# © 1998–2026 Miroslav Šotek. All rights reserved.
docs_dir: docs-site
strict: false
site_name: Director-AI
site_description: Real-time LLM hallucination guardrail — NLI + RAG fact-checking with token-level streaming halt
site_url: https://anulum.github.io/director-ai
site_author: Miroslav Šotek
repo_url: https://github.com/anulum/director-ai
repo_name: anulum/director-ai

copyright: "&copy; 1998–2026 Miroslav Šotek &middot; <a href='https://www.anulum.li'>anulum.li</a>"

theme:
  name: material
  icon:
    logo: material/shield-check
    repo: fontawesome/brands/github
  palette:
    - scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - announce.dismiss
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/anulum/director-ai
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/director-ai/
  generator: false
  version:
    provider: mike

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - mkdocs-jupyter:
      include: ["notebooks/*.ipynb"]
      execute: false
      allow_errors: false
      theme: dark
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            heading_level: 3
            members_order: source
            docstring_style: numpy
            show_signature_annotations: true
            separate_signature: true
            merge_init_into_class: true

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Quickstart: quickstart.md
      - Installation: installation.md
      - Why Director-AI: guide/why-director-ai.md
  - User Guide:
      - Scoring: guide/scoring.md
      - Streaming Halt: guide/streaming.md
      - Threshold Tuning: guide/threshold-tuning.md
      - KB Ingestion: guide/kb-ingestion.md
      - Evidence & Fallback: guide/evidence.md
      - Domain Presets: guide/presets.md
      - Configuration: guide/config.md
      - Error Handling: guide/error-handling.md
      - ONNX Export: guide/onnx-export.md
      - Quantization: guide/quantization.md
      - Rust FFI: guide/rust-ffi.md
      - Streaming Overhead: guide/streaming-overhead.md
      - Architecture: guide/architecture.md
      - Enterprise: guide/enterprise.md
      - AGPL Compliance: guide/agpl-compliance.md
      - Troubleshooting: guide/troubleshooting.md
      - Migration (v2→v3): guide/migration-v2-v3.md
  - Integrations:
      - OpenAI / Anthropic SDK: integrations/sdk-guard.md
      - LangChain: integrations/langchain.md
      - LlamaIndex: integrations/llamaindex.md
      - LangGraph: integrations/langgraph.md
      - Haystack: integrations/haystack.md
      - CrewAI: integrations/crewai.md
  - API Reference:
      - Overview: api/index.md
      - guard / score / get_score: api/guard.md
      - CoherenceScorer: api/scorer.md
      - StreamingKernel: api/streaming.md
      - CoherenceAgent: api/agent.md
      - VectorGroundTruthStore: api/vector-store.md
      - BatchProcessor: api/batch.md
      - DirectorConfig: api/config.md
      - Types & Dataclasses: api/types.md
      - NLI Backends: api/nli.md
      - Score Cache: api/cache.md
      - Input Sanitizer: api/sanitizer.md
      - Enterprise: api/enterprise.md
      - VerifiedScorer: api/verified-scorer.md
      - Knowledge API: api/knowledge.md
      - REST Server: api/server.md
      - gRPC Server: api/grpc.md
      - CLI: api/cli.md
      - Exceptions: api/exceptions.md
  - Deployment:
      - Production Guide: deployment/production.md
      - Docker: deployment/docker.md
      - Metrics: deployment/metrics.md
      - Monitoring: deployment/monitoring.md
      - Production Checklist: deployment/checklist.md
      - Operational Runbooks: deployment/runbooks.md
  - Cookbook:
      - Legal: cookbook/legal.md
      - Medical: cookbook/medical.md
      - Finance: cookbook/finance.md
      - Customer Support: cookbook/customer-support.md
      - Case Studies: cookbook/case-studies.md
  - Benchmarks: benchmarks.md
  - Tutorials:
      - Overview: tutorials.md
      - Quickstart Notebook: notebooks/quickstart.ipynb
      - Coherence Engine: notebooks/01_coherence_engine.ipynb
      - Streaming Oversight: notebooks/02_streaming_oversight.ipynb
      - Vector Store & Retrieval: notebooks/03_vector_store.ipynb
      - End-to-End Benchmark: notebooks/04_end_to_end_benchmark.ipynb
      - Medical RAG Chatbot: notebooks/06_medical_rag_chatbot.ipynb
      - LangChain Integration: notebooks/07_langchain_integration.ipynb
      - Multi-Provider SDK Guard: notebooks/08_provider_adapters.ipynb
      - Production Guardrails: notebooks/09_production_guardrails.ipynb
      - Vector RAG Pipeline: notebooks/10_vector_rag_pipeline.ipynb
      - Streaming Halt Deep Dive: notebooks/11_streaming_halt_deep_dive.ipynb
      - Domain Presets & Config: notebooks/12_domain_presets_and_config.ipynb
      - Batch Processing: notebooks/13_batch_processing_and_evaluation.ipynb
      - Enterprise Multi-Tenant: notebooks/14_enterprise_multi_tenant.ipynb
      - Custom Fine-Tuning: notebooks/15_custom_fine_tuning.ipynb
  - Glossary: glossary.md
  - Changelog: changelog.md
  - Licensing: licensing.md