mkdocs.yml

site_name: Phlo Lakehouse Platform
site_description: Documentation for the Phlo data lakehouse platform
site_author: Phlo Team

theme:
  name: material
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.expand
    - navigation.prune
    - navigation.indexes
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
    - content.code.select
    - search.suggest
    - search.highlight
    - search.share
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

plugins:
  - search
  - mermaid2
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_symbol_type_toc: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Core Concepts: getting-started/core-concepts.md
  - Guides:
      - Developer Guide: guides/developer-guide.md
      - Workflow Development: guides/workflow-development.md
      - Data Migrations: guides/data-migrations.md
      - dbt Development: guides/dbt-development.md
      - Data Modeling: guides/data-modeling.md
      - Dagster Assets: guides/dagster-assets.md
      - Capability Primitives: guides/capability-primitives.md
      - Orchestrator Adapters: guides/orchestrator-adapters.md
      - Operations Contracts: guides/operations-contracts.md
      - Logging: guides/logging.md
      - Hook Event Bus: guides/hook-event-bus.md
      - Semantic Layer: guides/semantic-layer.md
      - Plugin Development: guides/plugin-development.md
      - Plugin Registry: guides/plugin-registry.md
      - Compose Generation: guides/compose-generation.md
      - Service Packages: guides/service-packages.md
      - Discovery And Registry Benchmarks: guides/discovery-registry-benchmarks.md
      - Testing Strategy: guides/testing-strategy.md
  - Setup:
      - Hasura: setup/hasura.md
      - PostgREST: setup/postgrest.md
      - Observability: setup/observability.md
      - OpenMetadata: setup/openmetadata.md
      - Security: setup/security.md
  - Packages:
      - Overview: packages/index.md
      - Data Processing:
          - phlo-dagster: packages/phlo-dagster.md
          - phlo-dlt: packages/phlo-dlt.md
          - phlo-dbt: packages/phlo-dbt.md
          - phlo-iceberg: packages/phlo-iceberg.md
          - phlo-delta: packages/phlo-delta.md
          - phlo-pandera: packages/phlo-pandera.md
          - phlo-lineage: packages/phlo-lineage.md
      - Infrastructure:
          - phlo-postgres: packages/phlo-postgres.md
          - phlo-nessie: packages/phlo-nessie.md
          - phlo-trino: packages/phlo-trino.md
          - phlo-minio: packages/phlo-minio.md
          - phlo-rustfs: packages/phlo-rustfs.md
      - Observability:
          - phlo-grafana: packages/phlo-grafana.md
          - phlo-prometheus: packages/phlo-prometheus.md
          - phlo-loki: packages/phlo-loki.md
          - phlo-alloy: packages/phlo-alloy.md
          - phlo-otel: packages/phlo-otel.md
          - phlo-clickstack: packages/phlo-clickstack.md
          - phlo-alerting: packages/phlo-alerting.md
      - API Layer:
          - phlo-api: packages/phlo-api.md
          - phlo-mcp: packages/phlo-mcp.md
          - phlo-postgrest: packages/phlo-postgrest.md
          - phlo-hasura: packages/phlo-hasura.md
      - Data Catalog:
          - phlo-openmetadata: packages/phlo-openmetadata.md
      - User Interface:
          - phlo-observatory: packages/phlo-observatory.md
          - phlo-superset: packages/phlo-superset.md
          - phlo-pgweb: packages/phlo-pgweb.md
      - Development:
          - phlo-testing: packages/phlo-testing.md
          - phlo-core-plugins: packages/phlo-core-plugins.md
  - Reference:
      - Architecture: reference/architecture.md
      - API Reference: reference/phlo-api.md
      - Canonical RBAC: reference/canonical-rbac.md
      - CLI Reference: reference/cli-reference.md
      - Configuration: reference/configuration-reference.md
      - Plugin API: reference/plugin-api.md
      - Quality Checks Catalog: reference/quality-checks-catalog.md
      - DuckDB Queries: reference/duckdb-queries.md
      - Common Errors: reference/common-errors.md
  - Errors:
      - Error Index: errors/README.md
      - PHLO-001 Asset Not Discovered: errors/PHLO-001.md
      - PHLO-002 Schema Mismatch: errors/PHLO-002.md
      - PHLO-003 Invalid Cron: errors/PHLO-003.md
      - PHLO-004 Validation Failed: errors/PHLO-004.md
      - PHLO-005 Missing Schema: errors/PHLO-005.md
      - PHLO-006 Ingestion Failed: errors/PHLO-006.md
      - PHLO-007 Table Not Found: errors/PHLO-007.md
      - PHLO-008 Infrastructure Error: errors/PHLO-008.md
      - PHLO-200 Schema Conversion: errors/PHLO-200.md
      - PHLO-201 Type Conversion: errors/PHLO-201.md
      - PHLO-300 DLT Pipeline Failed: errors/PHLO-300.md
      - PHLO-301 DLT Source Error: errors/PHLO-301.md
      - PHLO-400 Iceberg Catalog: errors/PHLO-400.md
      - PHLO-401 Iceberg Table: errors/PHLO-401.md
      - PHLO-402 Iceberg Write: errors/PHLO-402.md
  - Observatory:
      - Extensions: observatory/extensions.md
  - Operations:
      - Operations Guide: operations/operations-guide.md
      - Audit Logging: operations/audit-logging.md
      - Production Readiness: operations/production-readiness.md
      - Best Practices: operations/best-practices.md
      - Testing: operations/testing.md
      - Troubleshooting: operations/troubleshooting.md