mkdocs.yml

site_name: Open Resource Broker
site_description: Unified API for orchestrating and provisioning compute capacity
site_url: https://finos.github.io/open-resource-broker
repo_url: https://github.com/finos/open-resource-broker
repo_name: open-resource-broker

# Appropriate docs structure: mkdocs.yml in docs/, markdown files in docs/root/
docs_dir: root
site_dir: site

# GitHub-specific settings
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/orb-icon.svg
  favicon: assets/orb-icon.png
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - content.code.annotate
    - content.code.copy
    - content.tabs.link

# Mike versioning configuration
extra:
  version:
    provider: mike

extra_css:
  - assets/extra.css

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: ["..", "../src"]
          options:
            show_source: true
            show_root_heading: true
            show_root_toc_entry: false
            docstring_style: google
            merge_init_into_class: true
            show_signature_annotations: true
            show_bases: true
            show_inheritance_diagram: false
            filters: ["!^_"]
            heading_level: 1

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
    - Quick Start: getting_started/quick_start.md
    - Installation: user_guide/installation.md
    - Configuration: user_guide/configuration.md
  - User Guide:
    - Templates: user_guide/templates.md
    - Requests: user_guide/requests.md
    - Storage Strategies: user_guide/storage_strategies.md
    - Monitoring: user_guide/monitoring.md
    - Troubleshooting: user_guide/troubleshooting.md
    - Deployment: user_guide/deployment.md
    - API Reference: user_guide/api_reference.md
    - Infrastructure Commands: user_guide/infrastructure-commands.md
    - Attribute-Based Instance Selection: user_guide/abis.md
  - Architecture & Development:
    - Architecture:
      - System Overview: architecture/system_overview.md
      - Clean Architecture: architecture/clean_architecture.md
      - Template Infrastructure: architecture/template-infrastructure.md
      - System Diagrams: architecture/system_diagrams.md
      - CQRS Pattern: architecture/cqrs_pattern.md
      - Dependency Injection: architecture/dependency_injection.md
      - Lazy Loading Design: architecture/lazy-loading-design.md
      - Machine Discovery Flow: architecture/machine-discovery-flow.md
      - Multi-Provider Design: architecture/multi-provider-design.md
      - Field Mapping Architecture: architecture/field_mapping_architecture.md
      - Metrics Report: architecture/metrics_report.md
    - Design Patterns:
      - Strategy Pattern: patterns/strategy_pattern.md
      - Factory Pattern: patterns/factory_pattern.md
      - Repository Pattern: patterns/repository_pattern.md
      - Ports and Adapters: patterns/ports_and_adapters.md
    - Engineering Practices:
      - SOLID Principles: engineering/solid_principles.md
      - DRY Principle: engineering/dry_principle.md
      - Separation of Concerns: engineering/separation_of_concerns.md
      - Dependency Inversion: engineering/dependency_inversion.md
    - Developer Guide:
      - Architecture Overview: developer_guide/architecture.md
      - CQRS Implementation: developer_guide/cqrs.md
      - Dependency Injection: developer_guide/dependency_injection.md
      - Data Models: developer_guide/data_models.md
      - Event System: developer_guide/events.md
      - Provider System: developer_guide/providers.md
      - Resilience Patterns: developer_guide/resilience.md
      - Performance Optimization: developer_guide/performance-optimization.md
      - Development Setup: developer_guide/development.md
      - BaseSetting Providers: developer_guide/basesettings-providers.md
      - Deprecating Fields & APIs: developer_guide/deprecation.md
      - Changelog Management: developer_guide/changelog_management.md
      - Releases: developer_guide/releases.md
      - Testing: developer_guide/testing.md
      - Testing Guide: development/testing.md
  - Deployment & Operations:
    - Deployment:
      - Overview: deployment/readme.md
      - Docker Deployment: deployment/docker.md
      - Cloud Platforms: deployment/cloud_platforms.md
      - Traditional Deployment: deployment/traditional.md
      - PyPI Setup: deployment/pypi-setup.md
      - Security: deployment/security.md
      - IAM Permissions: deployment/iam-permissions.md
      - Monitoring: deployment/monitoring.md
      - Dev Deployment: deployment/dev_deployment_documentation.md
    - Operations:
      - Backup and Recovery: operational/backup_recovery.md
      - Migration: operational/migration.md
      - Migrate from open-resource-broker: operational/from-open-resource-broker.md
      - Performance: operational/performance.md
      - Monitoring: operational/monitoring.md
      - Tools: operational/tools.md
    - HostFactory Integration:
      - Integration Guide: hostfactory/integration_guide.md
      - Requirements Compliance: hostfactory/requirements_compliance.md
      - Feature Mapping: hostfactory/feature_mapping.md
      - Deployment Scenarios: hostfactory/deployment_scenarios.md
      - Supported APIs: hostfactory/supported-apis.md
  - Providers:
    - Kubernetes:
      - Overview: providers/k8s/index.md
      - Infrastructure Discovery: providers/k8s/discovery.md
      - Configuration: providers/k8s/configuration.md
      - Handlers: providers/k8s/handlers.md
      - Authentication: providers/k8s/auth.md
      - Migrating from k8s-legacy: providers/k8s/migrating-from-k8s-legacy.md
      - Plugin Authoring: providers/k8s/plugin-authoring.md
  - CLI Reference:
    - Overview: cli/README.md
    - Full CLI Reference: cli/cli-reference.md
    - Template Commands: cli/template-commands.md
    - Scheduler Commands: cli/scheduler-commands.md
    - Infrastructure Commands: cli/infrastructure-commands.md
    - Multi-Provider Templates: cli/multi-provider-templates.md
    - Provider Override: cli/provider-override.md
    - Filtering: cli/filtering.md
  - MCP Integration:
    - Integration Guide: mcp/integration-guide.md
    - Tools Mode: mcp/tools-mode.md
    - API Reference: mcp/api-reference.md
  - SDK & Development:
    - SDK Quickstart: sdk/quickstart.md
    - Security Scanning: security/security-scanning.md
  - Reference:
    - API Reference:
      - Overview: api/readme.md
      - Native Spec Reference: api/native-spec-reference.md
      - Multi-Provider API: api/multi-provider-api.md
    - Configuration:
      - Configuration Guide: configuration-guide.md
      - Examples: configuration/examples.md
      - Native Spec Config: configuration/native-spec-config.md
      - Environment Variables: configuration/environment-variables.md
      - Multi-Provider: configuration/multi-provider.md
      - Provider Naming Guide: configuration/provider-naming-guide.md
    - Testing:
      - Testing Guide: testing/readme.md
      - System Tests (onaws): testing/system-tests-onaws.md
    - Guides & Patterns:
      - Native Spec Guide: native-spec-guide.md
      - Provider Strategy: provider_strategy_guide.md
      - Storage Registry: storage_registry_pattern.md
      - Format System: unified_format_system.md
      - Import Guidelines: import_guidelines.md
      - Versioning: versioning_guide.md
      - Architecture Assessment: architectural_assessment.md