site_name: LakeLogic
site_description: Trust Your Data. Scale Your Logic. SQL-first quality gates from Polars to petabytes.
site_url: https://LakeLogic.github.io/LakeLogic/
site_author: LakeLogic Team
repo_name: lakelogic/LakeLogic
repo_url: https://github.com/lakelogic/LakeLogic
edit_uri: edit/main/docs/
copyright: >
  Copyright &copy; 2026 <a href="https://lakelogic.org" target="_blank">LakeLogic</a> · 
  Open Source by <a href="https://github.com/LakeLogic" target="_blank">LakeLogic Team</a>

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/logo.svg
  icon:
    logo: material/shield-check
  font:
    text: "Inter"
    code: "JetBrains Mono"
  palette:
    # Light mode (default - matching LakeLogic)
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant        # Instant loading (SPA-like)
    - navigation.tracking       # URL updates with scroll
    - navigation.sections       # Expand sections in sidebar
    - navigation.expand         # Expand all sections by default
    - navigation.top            # Back to top button
    - navigation.footer         # Previous/next links
    - navigation.indexes        # Allow index pages for sections
    - toc.follow                # TOC follows scroll
    - search.suggest            # Search suggestions
    - search.highlight          # Highlight search terms
    - content.code.copy         # Copy button on code blocks
    - content.code.annotate     # Code annotations
    - content.tabs.link         # Linked content tabs

nav:
  - Home: index.md
  - Getting Started:
      - Installation: installation.md
      - "Quickstart: Hello World": examples/01_hello_world.ipynb
  - Concepts:
      - Architecture Overview: architecture_diagram.md
      - How it Works: concepts.md
      - Return Values: return_values.md
      - Contract Organization: organization.md
      - Ingestion & Cloud: ingestion.md
      - Real-Time Streaming: streaming.md
      - Reprocessing & Partitioning: reprocessing.md
      - Pipelines & Parallelism: pipelines.md
      - Automatic Credentials: automatic_credentials.md
      - Catalog Table Names: catalog_table_names.md
      - Delta Lake (Spark-Free): delta_lake_support.md
  - Tutorials:
      - Basic Validation: tutorials/basic_validation.md
      - Medallion Architecture: tutorials/medallion_architecture.md
      - Notifications & Secrets: tutorials/notifications_secrets.md
  - Notebooks:
      - "Database Governance": examples/02_database_governance.ipynb
      - "HIPAA & GDPR Compliance": examples/hipaa_gdpr_compliance.ipynb
      - "Bronze Quality Gate": examples/bronze_quality_gate.ipynb
      - "Medallion Architecture": examples/medallion_architecture.ipynb
      - "Dedup & Survivorship": examples/dedup_survivorship.ipynb
      - "SCD2 Dimension": examples/scd2_dimension.ipynb
      - "Soft Delete (CDC)": examples/soft_delete.ipynb
      - "Reference Joins": examples/reference_joins.ipynb
  - Patterns:
      - Overview: playbooks.md
      - Bronze Quality Gate: patterns/bronze_quality_gate.md
      - Dedup & Survivorship: patterns/dedup_survivorship.md
      - SCD2 Dimension: patterns/scd2_dimension.md
      - Late Arriving Reprocess: patterns/late_arriving_reprocess.md
      - External Python Logic: patterns/external_python_logic.md
  - Deployment:
      - Deployment Patterns: deployment_patterns.md
      - Job Templates: job_templates.md
  - Observability:
      - Overview: observability.md
      - Lineage & Reconciliation: reconciliation.md
      - Notifications & Alerting: notifications.md
  - Reference:
      - Contract Template: contract_template.md
      - CLI: cli.md
      - Driver: driver.md
      - Bootstrap: bootstrap.md
      - API: api.md
      - Capability Matrix: capabilities.md
      - Public Streaming Sources: streaming_sources.md
      - Logging Configuration: logging_configuration.md
      - Validation Result: validation_result.md
      - Release & Maintenance: maintenance.md
  - Why LakeLogic?: comparison.md

plugins:
  - search
  - mkdocs-jupyter:
      include_source: true

not_in_nav: |
  _backups/**

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - admonition
  - attr_list
  - md_in_html

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/theme-switcher.js

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/lakelogic/LakeLogic
      name: LakeLogic on GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/lakelogic/
      name: LakeLogic on PyPI
    - icon: fontawesome/solid/globe
      link: https://lakelogic.org
      name: LakeLogic.org Website
  generator: false
