mkdocs.yml

site_name: Shepherd Model Gateway
site_description: High-performance inference gateway for large-scale LLM deployments
site_url: https://lightseekorg.github.io/smg
repo_url: https://github.com/lightseekorg/smg
repo_name: lightseekorg/smg
edit_uri: edit/main/docs/

copyright: Copyright © 2024 SMG Contributors

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/images/logo.svg
  favicon: assets/images/favicon.svg
  palette:
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - minify:
      minify_html: true

extra:
  status:
    new: Recently added
    deprecated: Deprecated
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/lightseekorg/smg
    - icon: fontawesome/brands/slack
      link: https://join.slack.com/t/lightseekorg/shared_invite/zt-3py6mpreo-XUGd064dSsWeQizh3YKQrQ
  generator: false
  version:
    provider: mike

extra_css:
  - assets/stylesheets/extra.css

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: lightseekorg
      repo: smg
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Home: index.md
  - Getting Started:
      - getting-started/index.md
      - Core Setup:
          - Multiple Workers: getting-started/multiple-workers.md
          - gRPC Workers: getting-started/grpc-workers.md
          - PD Disaggregation: getting-started/pd-disaggregation.md
          - Service Discovery: getting-started/service-discovery.md
      - Operations:
          - Monitoring: getting-started/monitoring.md
          - Logging: getting-started/logging.md
          - TLS: getting-started/tls.md
          - Control Plane Auth: getting-started/control-plane-auth.md
          - Control Plane Operations: getting-started/control-plane-operations.md
      - Reliability and Data:
          - Reliability Controls: getting-started/reliability-controls.md
          - Data Connections: getting-started/data-connections.md
          - Tokenization and Parsing APIs: getting-started/tokenization-and-parsing.md
      - Advanced Features:
          - Load Balancing: getting-started/load-balancing.md
          - Tokenizer Caching: getting-started/tokenizer-caching.md
          - MCP in Responses API: getting-started/mcp.md
          - External Providers: getting-started/external-providers.md
  - Concepts:
      - concepts/index.md
      - Architecture:
          - Overview: concepts/architecture/overview.md
          - Service Discovery: concepts/architecture/service-discovery.md
          - gRPC Pipeline: concepts/architecture/grpc-pipeline.md
          - High Availability: concepts/architecture/high-availability.md
      - Routing:
          - Load Balancing: concepts/routing/load-balancing.md
          - Cache-Aware Routing: concepts/routing/cache-aware.md
          - PD Disaggregation: concepts/routing/pd-disaggregation.md
      - Performance:
          - Tokenizer Caching: concepts/performance/tokenizer-caching.md
      - Extensibility:
          - WASM Plugins: concepts/extensibility/wasm-plugins.md
          - Model Context Protocol: concepts/extensibility/mcp.md
      - Reliability:
          - Circuit Breakers: concepts/reliability/circuit-breakers.md
          - Rate Limiting: concepts/reliability/rate-limiting.md
          - Retries: concepts/reliability/retries.md
          - Health Checks: concepts/reliability/health-checks.md
          - Graceful Shutdown: concepts/reliability/graceful-shutdown.md
      - Data:
          - Chat History: concepts/data/chat-history.md
      - Security:
          - Authentication: concepts/security/authentication.md
  - Reference:
      - reference/index.md
      - API:
          - OpenAI Compatible: reference/api/openai.md
          - Responses API: reference/api/responses.md
          - Anthropic Messages API: reference/api/messages.md
          - Admin API: reference/api/admin.md
          - Gateway Extensions: reference/api/extensions.md
      - Configuration: reference/configuration.md
      - Metrics: reference/metrics.md
      - Internal MCP Servers: reference/mcp-internal-servers.md
  - Contributing:
      - contributing/index.md
      - Development Setup: contributing/development.md
      - Code Style: contributing/code-style.md