mkdocs.yml

site_name: Pipelex Documentation
site_url: https://docs.pipelex.com/
site_description: "Official documentation for Pipelex, a framework and language for building deterministic, repeatable AI workflows and knowledge pipelines."
docs_dir: docs
repo_url: "https://github.com/Pipelex/pipelex"
repo_name: "Pipelex on GitHub"
theme:
  name: material
  custom_dir: docs/overrides
  favicon: images/pipelex-favicon-32.png
  logo: https://pipelex-web.s3.amazonaws.com/logo/Pipelex-logo-wot-mono-560x176.png
  features:
    - navigation.footer
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - content.code.copy
  palette:
  - scheme: default          # light
    primary: custom
    toggle:
      icon: material/weather-night
      name: Switch to dark mode
  - scheme: slate            # dark
    primary: custom
    toggle:
      icon: material/weather-sunny
      name: Switch to light mode

copyright: "© 2025 Evotis S.A.S. <br/>Pipelex is a trademark of Evotis S.A.S."

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Pipelex/pipelex
      name: Pipelex on GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pipelex/
      name: pipelex on PyPI
    - icon: fontawesome/brands/twitter
      link: https://x.com/PipelexAI
      name: Pipelex on X
    - icon: fontawesome/brands/discord
      link: https://go.pipelex.com/discord
      name: Pipelex on Discord
  generator: false

plugins:
  - search
  - meta-manager
  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      slide_effect: slide
      width: 100%
      height: auto
      zoomable: true
      draggable: true
      auto_caption: false
      caption_position: bottom

markdown_extensions:
  - meta
  - sane_lists
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.blocks.caption
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets:
      base_path: .
      check_paths: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  
extra_css:
  - stylesheets/mermaid.css
  - stylesheets/general.css

nav:
  - Home:
    - What is Pipelex?: index.md
    - Get Started:
      - The Pipe Builder: home/2-get-started/pipe-builder.md
      - Write Workflows Manually: home/2-get-started/write-workflows-manually.md
    - Understand Pipelex:
      - The Knowledge Pipeline Manifesto: home/3-understand-pipelex/manifesto.md
      - The Pipelex Paradigm: home/3-understand-pipelex/pipelex-paradigm/index.md
    - Cookbook Examples:
      - Overview: home/4-cookbook-examples/index.md
      - Hello World: home/4-cookbook-examples/hello-world.md
      - Document Processing:
        - Simple OCR: home/4-cookbook-examples/simple-ocr.md
        - Generic Document Extraction: home/4-cookbook-examples/extract-generic.md
        - Invoice Extractor: home/4-cookbook-examples/invoice-extractor.md
        - Proof of Purchase Extraction: home/4-cookbook-examples/extract-proof-of-purchase.md
      - Graphical Extraction:
        - Gantt Chart Extraction: home/4-cookbook-examples/extract-gantt.md
        - Table Extraction from Image: home/4-cookbook-examples/extract-table.md
        - DPE Extraction: home/4-cookbook-examples/extract-dpe.md
      - Text Generation:
        - Screenplay Generator (wip): home/4-cookbook-examples/write-screenplay.md
        - Tweet Optimizer (wip): home/4-cookbook-examples/write-tweet.md
    - Setup:
      - Configure AI Providers: home/5-setup/configure-ai-providers.md
      - Project Organization: home/5-setup/project-organization.md
      - Telemetry: home/5-setup/telemetry.md
    - Build Reliable AI Workflows:
      - Kick off a Pipeline Project: home/6-build-reliable-ai-workflows/kick-off-a-pipelex-workflow-project.md
      - Pipe Builder: home/6-build-reliable-ai-workflows/pipe-builder.md
      - Pipelex Bundle Specification: home/6-build-reliable-ai-workflows/pipelex-bundle-specification.md
      - Domain: home/6-build-reliable-ai-workflows/domain.md
      - Concepts:
        - Define Your Concepts: home/6-build-reliable-ai-workflows/concepts/define_your_concepts.md
        - Inline structures: home/6-build-reliable-ai-workflows/concepts/inline-structures.md
        - Python classes: home/6-build-reliable-ai-workflows/concepts/python-classes.md
        - Native Concepts: home/6-build-reliable-ai-workflows/concepts/native-concepts.md
        - Refining Concepts: home/6-build-reliable-ai-workflows/concepts/refining-concepts.md
      - Design and Run Pipelines:
        - Overview: home/6-build-reliable-ai-workflows/pipes/index.md
        - Executing Pipelines: home/6-build-reliable-ai-workflows/pipes/executing-pipelines.md
        - Providing Inputs to Pipelines: home/6-build-reliable-ai-workflows/pipes/provide-inputs.md
        - Working Memory: home/6-build-reliable-ai-workflows/pipes/working-memory.md
        - Pipe Output: home/6-build-reliable-ai-workflows/pipes/pipe-output.md
        - Understanding Multiplicity: home/6-build-reliable-ai-workflows/pipes/understanding-multiplicity.md
        - Pipe Operators:
          - Overview: home/6-build-reliable-ai-workflows/pipes/pipe-operators/index.md
          - PipeLLM: home/6-build-reliable-ai-workflows/pipes/pipe-operators/PipeLLM.md
          - PipeExtract: home/6-build-reliable-ai-workflows/pipes/pipe-operators/PipeExtract.md
          - PipeImgGen: home/6-build-reliable-ai-workflows/pipes/pipe-operators/PipeImgGen.md
          - PipeCompose: home/6-build-reliable-ai-workflows/pipes/pipe-operators/PipeCompose.md
          - PipeFunc: home/6-build-reliable-ai-workflows/pipes/pipe-operators/PipeFunc.md
        - Pipe Controllers:
          - Overview: home/6-build-reliable-ai-workflows/pipes/pipe-controllers/index.md
          - PipeSequence: home/6-build-reliable-ai-workflows/pipes/pipe-controllers/PipeSequence.md
          - PipeParallel: home/6-build-reliable-ai-workflows/pipes/pipe-controllers/PipeParallel.md
          - PipeBatch: home/6-build-reliable-ai-workflows/pipes/pipe-controllers/PipeBatch.md
          - PipeCondition: home/6-build-reliable-ai-workflows/pipes/pipe-controllers/PipeCondition.md
      - Optimize Cost & Quality: home/6-build-reliable-ai-workflows/configure-ai-llm-to-optimize-workflows.md
      - LLM Structured Generation: home/6-build-reliable-ai-workflows/llm-structured-generation-config.md
      - LLM Prompting Style: home/6-build-reliable-ai-workflows/adapt-to-llm-prompting-style-openai-anthropic-mistral.md
    - Configuration:
      - Overview: home/7-configuration/index.md
      - Pipeline Validation Configuration:
        - Dry Run: home/7-configuration/config-pipeline-validation/dry-run-config.md
        - Static Validation: home/7-configuration/config-pipeline-validation/static-validation-config.md
      - Practical Configuration:
        - Logging: home/7-configuration/config-practical/logging-config.md
        - Pipe Run: home/7-configuration/config-practical/pipe-run-config.md
        - Reporting: home/7-configuration/config-practical/reporting-config.md
        - Telemetry: home/7-configuration/config-practical/telemetry-config.md
        - Tracker: home/7-configuration/config-practical/tracker-config.md
      - Technical Configuration:
        - AWS: home/7-configuration/config-technical/aws-config.md
        - Cogt: home/7-configuration/config-technical/cogt-config.md
        - LLM Providers & Models: home/7-configuration/config-technical/inference-backend-config.md
        - Library: home/7-configuration/config-technical/library-config.md
        - Feature: home/7-configuration/config-advanced/feature-config.md
    - Analytics:
      - Observer Data Extraction: home/8-analytics/data-extraction.md
    - Tools:
      - CLI: home/9-tools/cli.md
      - Kit Commands: home/9-tools/kit.md
      - Pipe Builder: home/9-tools/pipe-builder.md
      - Logging: home/9-tools/logging.md
    - Advanced Customizations:
      - Overview: home/10-advanced-customizations/index.md
      - Secrets Provider: home/10-advanced-customizations/secrets-provider-injection.md
      - Reporting Delegate: home/10-advanced-customizations/reporting-delegate-injection.md
      - Pipeline Tracker: home/10-advanced-customizations/pipeline-tracker-injection.md
      - Storage Provider: home/10-advanced-customizations/storage-provider-injection.md
      - Template Provider: home/10-advanced-customizations/template-provider-injection.md
      - Observer Provider: home/10-advanced-customizations/observer-provider-injection.md
      - Content Generator: home/10-advanced-customizations/content-generator-injection.md
      - Plugin Injection: home/10-advanced-customizations/plugin-injection.md
      - Pipe Router: home/10-advanced-customizations/pipe-router-injection.md
  - API: https://pipelex.github.io/pipelex-api/
  - MCP: https://pipelex.github.io/pipelex-mcp/
  - n8n: https://pipelex.github.io/n8n-nodes-pipelex/
  - Contribute:
    - Contributing: contributing.md
    - Code of Conduct: CODE_OF_CONDUCT.md
    - License: license.md
  - Changelog: changelog.md