mkdocs.yml

site_name: Spindle by SQLLocks
site_url: https://sqllocks.github.io/spindle
site_description: Multi-domain, schema-aware synthetic data generator for Microsoft Fabric
site_author: Jonathan Stewart
repo_url: https://github.com/sqllocks/spindle
repo_name: sqllocks/spindle

theme:
  name: material
  palette:
    - scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
    - toc.follow
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            show_category_heading: true
            members_order: source
  - gen-files:
      scripts:
        - scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index

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

nav:
  - Home: index.md
  - Getting Started:
    - Before You Start: getting-started/before-you-start.md
    - 60-Second Overview: getting-started/60-seconds.md
    - Quickstart (Python): getting-started/quickstart.md
    - Quickstart (CLI): getting-started/quickstart-cli.md
    - Quickstart (Fabric): getting-started/quickstart-fabric.md
    - Installation: getting-started/installation.md
    - CLI Cheatsheet: getting-started/cli-cheatsheet.md
  - Tutorials:
    - Learning Paths: tutorials/index.md
    - Beginner:
      - "01: Hello Spindle": tutorials/beginner/01-hello-spindle.md
      - "02: Explore Domains": tutorials/beginner/02-explore-domains.md
      - "03: Custom Schemas": tutorials/beginner/03-custom-schemas.md
      - "04: Output Formats": tutorials/beginner/04-output-formats.md
    - Intermediate:
      - "05: Star Schema": tutorials/intermediate/05-star-schema.md
      - "06: Streaming": tutorials/intermediate/06-streaming.md
      - "07: Chaos Engineering": tutorials/intermediate/07-chaos-engineering.md
      - "08: Validation Gates": tutorials/intermediate/08-validation-gates.md
      - "09: Composite Domains": tutorials/intermediate/09-composite-domains.md
    - Fabric:
      - "10: Fabric Lakehouse": tutorials/fabric/10-fabric-lakehouse.md
      - "11: Fabric Warehouse": tutorials/fabric/11-fabric-warehouse.md
      - "12: Fabric Streaming": tutorials/fabric/12-fabric-streaming.md
      - "13: Medallion Architecture": tutorials/fabric/13-medallion.md
    - Advanced:
      - "14: Scenario Packs": tutorials/advanced/14-scenario-packs.md
      - "15: GSL Specs": tutorials/advanced/15-gsl-specs.md
      - "16: Day 2 Operations": tutorials/advanced/16-day2-operations.md
      - "17: CI Integration": tutorials/advanced/17-ci-integration.md
  - Guides:
    - Generation Strategies: guides/strategies.md
    - Custom Schemas: guides/custom-schemas.md
    - Distribution Profiles: guides/profiles.md
    - DDL Import: guides/ddl-import.md
    - Schema Learning: guides/schema-learning.md
    - Incremental & Day 2: guides/incremental-day2.md
    - Composite Presets: guides/presets.md
    - Semantic Model Export: guides/semantic-model.md
    - Chaos Engine: guides/chaos.md
    - Validation Gates: guides/validation.md
    - Verifying Data Quality: guides/verify.md
    - Simulation: guides/simulation.md
    - Streaming: guides/streaming.md
    - Composite Domains: guides/composite-domains.md
    - GSL Specs: guides/gsl-specs.md
    - MCP Server: guides/mcp-server.md
    - Fabric Lakehouse: guides/fabric-lakehouse.md
    - Fabric Warehouse: guides/fabric-warehouse.md
    - Fabric SQL Database: guides/fabric-sql-database.md
    - Fabric Notebooks: guides/fabric-notebook.md
    - Fabric Provisioning: guides/fabric-provisioning.md
    - Star Schema Export: guides/star-schema.md
    - CDM Export: guides/cdm-export.md
    - Troubleshooting: guides/troubleshooting.md
  - Domains:
    - domains/index.md
    - Retail: domains/retail.md
    - Healthcare: domains/healthcare.md
    - Financial: domains/financial.md
    - Supply Chain: domains/supply-chain.md
    - IoT: domains/iot.md
    - HR: domains/hr.md
    - Insurance: domains/insurance.md
    - Marketing: domains/marketing.md
    - Education: domains/education.md
    - Real Estate: domains/real-estate.md
    - Manufacturing: domains/manufacturing.md
    - Telecom: domains/telecom.md
    - Capital Markets: domains/capital-markets.md
  - Methodology: methodology/calibration.md
  - API Reference: reference/
  - Changelog: changelog.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/sqllocks/spindle
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/sqllocks-spindle/
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/sqllocks/

copyright: Copyright © 2025-2026 SQLLocks (Jonathan Stewart)