mkdocs.yml

site_name: Selectools
site_description: Production-ready AI agents with tool calling, RAG, and hybrid search
site_url: https://selectools.dev
repo_url: https://github.com/johnnichev/selectools
repo_name: johnnichev/selectools
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow
  icon:
    repo: fontawesome/brands/github
    admonition:
      note: fontawesome/solid/note-sticky
      tip: fontawesome/solid/lightbulb
      warning: fontawesome/solid/triangle-exclamation
      danger: fontawesome/solid/skull-crossbones
      example: fontawesome/solid/flask
  font:
    text: Plus Jakarta Sans
    code: JetBrains Mono

plugins:
  - search
  - tags
  - git-revision-date-localized:
      type: date
      enable_creation_date: true
      fallback_to_build_date: true
  - glightbox:
      touchNavigation: true
      loop: false
      zoomable: true
  - minify:
      minify_html: true

not_in_nav: |
  README.md
  CLAUDE.md
  RELEASE_GUIDE.md

markdown_extensions:
  - admonition
  - 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.tabbed:
      alternate_style: true
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - tables
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - Get Started:
    - Quickstart: QUICKSTART.md
    - Migration Guides: MIGRATION.md
    - Cookbook: COOKBOOK.md
    - API Keys: KEYS.md
    - Architecture: ARCHITECTURE.md
  - Core:
    - Agent: modules/AGENT.md
    - Tools: modules/TOOLS.md
    - Toolbox (33 Built-in): modules/TOOLBOX.md
    - Dynamic Tools: modules/DYNAMIC_TOOLS.md
    - Streaming: modules/STREAMING.md
    - Multimodal Messages: modules/MULTIMODAL.md
    - Memory: modules/MEMORY.md
    - Sessions: modules/SESSIONS.md
    - Providers: modules/PROVIDERS.md
    - Azure OpenAI: modules/AZURE_OPENAI.md
    - Models & Pricing: modules/MODELS.md
    - Usage & Cost: modules/USAGE.md
  - Features:
    - RAG Pipeline: modules/RAG.md
    - Hybrid Search: modules/HYBRID_SEARCH.md
    - Chunking: modules/ADVANCED_CHUNKING.md
    - Embeddings: modules/EMBEDDINGS.md
    - Vector Stores: modules/VECTOR_STORES.md
    - FAISS: modules/FAISS.md
    - Qdrant: modules/QDRANT.md
    - pgvector: modules/PGVECTOR.md
    - Guardrails: modules/GUARDRAILS.md
    - Eval Framework: modules/EVALS.md
    - Orchestration: modules/ORCHESTRATION.md
    - Supervisor: modules/SUPERVISOR.md
    - Pipelines: modules/PIPELINE.md
    - Patterns: modules/PATTERNS.md
  - Advanced:
    - Entity Memory: modules/ENTITY_MEMORY.md
    - Knowledge Graph: modules/KNOWLEDGE_GRAPH.md
    - Knowledge Memory: modules/KNOWLEDGE.md
    - MCP Client/Server: modules/MCP.md
    - Token Budget: modules/BUDGET.md
    - Cancellation: modules/CANCELLATION.md
    - Loop Detection: modules/LOOP_DETECTION.md
    - Token Estimation: modules/TOKEN_ESTIMATION.md
    - Model Switching: modules/MODEL_SWITCHING.md
    - Reasoning Strategies: modules/REASONING_STRATEGIES.md
    - Tool Result Caching: modules/TOOL_CACHING.md
    - Semantic Cache: modules/SEMANTIC_CACHE.md
    - Prompt Compression: modules/PROMPT_COMPRESSION.md
    - Conversation Branching: modules/CONVERSATION_BRANCHING.md
  - Deploy:
    - Visual Builder: modules/builder.md
    - Serve & Deploy: modules/SERVE.md
    - Agent Templates: modules/TEMPLATES.md
  - Reference:
    - Security Audit: SECURITY.md
    - Audit Logging: modules/AUDIT.md
    - Screening: modules/SECURITY.md
    - Error Handling: modules/EXCEPTIONS.md
    - Trace Store: modules/TRACE_STORE.md
    - OpenTelemetry: modules/OTEL.md
    - Langfuse: modules/LANGFUSE.md
    - Stability Markers: modules/STABILITY.md
    - Changelog: CHANGELOG.md
    - Architecture Decisions:
      - Protocol over ABC: decisions/001-protocol-over-abc.md
      - Observer Replaces Hooks: decisions/002-observer-replaces-hooks.md
      - Literal to Enum: decisions/003-literal-to-enum.md
      - Provider Base Class: decisions/004-provider-base-class.md

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/copy-markdown.js
  - javascripts/fix-logo-link.js

extra:
  # When the docs logo/title is clicked, send users to the Quickstart
  # instead of the site root. The site root is the marketing landing page,
  # and Material's instant-navigation cannot render it inside the docs
  # shell, which previously caused a broken half-rendered state.
  homepage: https://selectools.dev/QUICKSTART/
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/johnnichev/selectools
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/selectools/
  generator: false