mkdocs.yml

site_name: IRIS
site_description: Event-driven market intelligence platform documentation
site_url: https://mesteriis.github.io/iris/
repo_url: https://github.com/Mesteriis/iris
repo_name: Mesteriis/iris
docs_dir: docs
site_dir: site

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/img/logo.png
  favicon: assets/img/logo.png
  font:
    text: Manrope
    code: JetBrains Mono
  palette:
    - scheme: slate
      primary: black
      accent: amber
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.footer
    - navigation.top
    - content.code.copy
    - search.highlight
    - search.suggest
  icon:
    repo: fontawesome/brands/github

plugins:
  - search

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - tables
  - toc:
      permalink: true

extra_css:
  - assets/stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Mesteriis/iris
      name: GitHub repository

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Market Data API Keys: market-data-api-keys.md
  - Open Source: open-source.md
  - Architecture:
      - Overview: architecture/index.md
      - ADRs:
          - Index: architecture/adr/index.md
          - ADR 0001: architecture/adr/0001-event-driven-runtime.md
          - ADR 0002: architecture/adr/0002-persistence-architecture.md
          - ADR 0003: architecture/adr/0003-control-plane-event-routing.md
          - ADR 0004: architecture/adr/0004-signal-fusion-layer.md
          - ADR 0005: architecture/adr/0005-analytical-snapshot-api-semantics.md
          - ADR 0006: architecture/adr/0006-portfolio-engine-separation.md
          - ADR 0007: architecture/adr/0007-cross-market-intelligence.md
          - ADR 0008: architecture/adr/0008-research-vs-production-runtime.md
          - ADR 0009: architecture/adr/0009-signals-service-engine-split.md
          - ADR 0010: architecture/adr/0010-caller-owns-commit-boundary.md
          - ADR 0011: architecture/adr/0011-analytical-engines-never-fetch.md
          - ADR 0012: architecture/adr/0012-services-return-domain-contracts.md
          - ADR 0013: architecture/adr/0013-async-classes-for-orchestration-pure-functions-for-analysis.md
          - ADR 0014: architecture/adr/0014-post-commit-side-effects-only.md
          - ADR 0015: architecture/adr/0015-ai-platform-layer.md
          - ADR 0016: architecture/adr/0016-error-taxonomy-boundary-localization.md
          - ADR 0017: architecture/adr/0017-text-ownership-localization-scope.md
          - ADR 0018: architecture/adr/0018-message-key-taxonomy-naming.md
          - ADR 0019: architecture/adr/0019-package-structure-import-rules.md
          - ADR 0020: architecture/adr/0020-dependency-direction-import-boundaries.md
          - ADR 0021: architecture/adr/0021-generated-presentation-artifact-ownership.md
          - ADR 0022: architecture/adr/0022-platform-maturity-additions.md
          - ADR 0023: architecture/adr/0023-documentation-structure-and-naming.md
          - ADR 0024: architecture/adr/0024-frontend-dashboard-composition-and-route-bootstrapping.md
          - ADR 0025: architecture/adr/0025-runtime-proxy-registry-for-public-market-sources.md
          - ADR 0026: architecture/adr/0026-observed-asset-inventory-is-db-owned.md
          - ADR 0027: architecture/adr/0027-live-market-source-capability-registry-in-redis.md
          - ADR 0028: architecture/adr/0028-market-data-source-catalog-and-support-tiers.md
          - ADR 0029: architecture/adr/0029-frontend-dashboard-live-stream-over-normalized-sse.md
      - Governance:
          - Terminology: architecture/terminology.md
          - Complexity Guardrails: architecture/complexity-guardrails.md
          - Principal Engineering Checklist: architecture/principal-engineering-checklist.md
      - Runtime Policies:
          - Service Layer Runtime Policies: architecture/service-layer-runtime-policies.md
          - Service Layer Performance Budgets: architecture/service-layer-performance-budgets.md
          - AI Runtime Policies: architecture/ai-runtime-policies.md
          - AI Performance Budgets: architecture/ai-performance-budgets.md
      - Notes:
          - Index: architecture/notes/index.md
          - Python 3.14 Runtime Notes: architecture/notes/python-314-runtime-notes.md
      - Archive:
          - Index: architecture/archive/index.md
          - I18n Error Standardization: architecture/archive/i18n-error-standardization.md
  - Delivery:
      - Overview: delivery/index.md
      - Persistence Standard: delivery/persistence-standard.md
      - Persistence Audit: delivery/persistence-audit.md
      - HTTP Endpoint Refactor Audit: delivery/http-endpoint-refactor-audit.md
      - Service Layer Refactor Audit: delivery/service-layer-refactor-audit.md
      - Backend Business Localization Plan: delivery/backend-business-localization-plan.md
      - Lazy Investor AI Plan: delivery/lazy-investor-ai-plan.md
      - Archive:
          - Index: delivery/archive/index.md
          - HTTP API Progress: delivery/archive/http-api-progress.md
          - Service Layer Execution Plan: delivery/archive/service-layer-execution-plan.md
          - Service Layer Progress: delivery/archive/service-layer-progress.md
  - Product:
      - Overview: product/index.md
      - IRIS Value: product/iris-value.md
      - HTTP Endpoint Review Checklist: product/http-endpoint-review-checklist.md
      - Market Rate Limits: product/market-rate-limits.md
  - Home Assistant:
      - Overview: home-assistant/index.md
      - Protocol Specification: home-assistant/protocol-specification.md
      - Notes:
          - Index: home-assistant/notes/index.md
          - Integration Architecture: home-assistant/notes/integration-architecture.md
      - Archive:
          - Index: home-assistant/archive/index.md
          - Backend Implementation Plan: home-assistant/archive/backend-implementation-plan.md
          - HACS Integration Plan: home-assistant/archive/hacs-integration-plan.md
          - Task Backlog: home-assistant/archive/task-backlog.md
          - Progress Tracker: home-assistant/archive/progress-tracker.md
  - Generated:
      - Overview: _generated/index.md
      - HTTP Availability Matrix: _generated/http-availability-matrix.md
      - Translation Coverage: _generated/i18n-coverage.md
      - HTTP Capability Catalog: _generated/http-capability-catalog.md