mkdocs.yml

site_name: Durable Execution for workflows and agents
site_description: Conductor is an open-source durable code execution engine and agentic workflow engine. Orchestrate distributed workflows with saga pattern compensation, at-least-once task delivery, and polyglot workers in Java, Python, Go, and more.
repo_url: https://github.com/conductor-oss/conductor
site_url: https://conductor-oss.github.io/conductor
edit_uri: ''
strict: false
use_directory_urls: true

nav:
  - Home: index.md
  - Quickstart:
    - quickstart/index.md
    - Concepts: devguide/concepts/index.md
    - Workflows: devguide/concepts/workflows.md
    - Tasks: devguide/concepts/tasks.md
    - Workers: devguide/concepts/workers.md
    - Durable Execution: architecture/durable-execution.md
    - JSON + Code Native: architecture/json-native.md
    - Task Lifecycle: devguide/architecture/tasklifecycle.md
  - Guides:
    - Build with AI Agents: devguide/how-tos/conductor-skills.md
    - devguide/concepts/conductor.md
    - Workflows:
      - devguide/how-tos/Workflows/creating-workflows.md
      - devguide/how-tos/Workflows/starting-workflows.md
      - devguide/how-tos/Workflows/handling-errors.md
      - devguide/how-tos/Workflows/debugging-workflows.md
      - devguide/how-tos/Workflows/versioning-workflows.md
      - devguide/how-tos/Workflows/searching-workflows.md
      - devguide/how-tos/Workflows/viewing-workflow-executions.md
    - Tasks:
      - devguide/how-tos/Tasks/creating-tasks.md
      - devguide/how-tos/Tasks/task-inputs.md
      - devguide/how-tos/Tasks/choosing-tasks.md
      - devguide/how-tos/Workers/scaling-workers.md
    - Event Bus Orchestration: devguide/how-tos/event-bus.md
    - Best Practices: devguide/bestpractices.md
    - FAQ: devguide/faq.md
  - Cookbook:
    - devguide/cookbook/index.md
    - Microservice Orchestration: devguide/cookbook/microservice-orchestration.md
    - Dynamic Parallelism: devguide/cookbook/dynamic-parallelism.md
    - Wait & Timer Patterns: devguide/cookbook/wait-and-timers.md
    - Event-Driven Recipes: devguide/cookbook/event-driven.md
    - AI & LLM Recipes: devguide/cookbook/ai-llm.md
    - Dynamic Workflows in Code: devguide/cookbook/dynamic-workflows.md
  - AI Cookbook:
    - devguide/ai/index.md
    - Build Your First AI Agent: devguide/ai/first-ai-agent.md
    - Production Agent Architecture: devguide/ai/production-agent-architecture.md
    - Failure Semantics: devguide/ai/failure-semantics.md
    - Why Conductor for Agents: devguide/ai/why-conductor.md
    - MCP Integration: devguide/ai/mcp-guide.md
    - Durable Agents: devguide/ai/durable-agents.md
    - Human-in-the-Loop: devguide/ai/human-in-the-loop.md
    - Dynamic Workflows: devguide/ai/dynamic-workflows.md
    - LLM Orchestration: devguide/ai/llm-orchestration.md
    - Token Efficiency: devguide/ai/token-efficiency.md
  - SDKs:
    - devguide/sdk/index.md
    - Java: devguide/sdk/java-sdk.md
    - Python: devguide/sdk/python-sdk.md
    - Go: devguide/sdk/go-sdk.md
    - JavaScript: devguide/sdk/js-sdk.md
    - C#: devguide/sdk/csharp-sdk.md
    - Ruby: devguide/sdk/ruby-sdk.md
    - Rust: devguide/sdk/rust-sdk.md
  - Reference:
    - API:
      - devguide/api/index.md
      - devguide/api/metadata.md
      - devguide/api/startworkflow.md
      - devguide/api/workflow.md
      - devguide/api/task.md
      - devguide/api/bulk.md
      - devguide/api/eventhandlers.md
      - devguide/api/taskdomains.md
    - Workflow Definition:
      - devguide/configuration/workflowdef/index.md
    - System Tasks:
      - devguide/configuration/workflowdef/systemtasks/index.md
      - devguide/configuration/workflowdef/systemtasks/http-task.md
      - devguide/configuration/workflowdef/systemtasks/inline-task.md
      - devguide/configuration/workflowdef/systemtasks/event-task.md
      - devguide/configuration/workflowdef/systemtasks/human-task.md
      - devguide/configuration/workflowdef/systemtasks/json-jq-transform-task.md
      - devguide/configuration/workflowdef/systemtasks/kafka-publish-task.md
      - devguide/configuration/workflowdef/systemtasks/noop-task.md
      - devguide/configuration/workflowdef/systemtasks/wait-task.md
    - Operators:
      - devguide/configuration/workflowdef/operators/index.md
      - devguide/configuration/workflowdef/operators/fork-task.md
      - devguide/configuration/workflowdef/operators/join-task.md
      - devguide/configuration/workflowdef/operators/switch-task.md
      - devguide/configuration/workflowdef/operators/do-while-task.md
      - devguide/configuration/workflowdef/operators/dynamic-task.md
      - devguide/configuration/workflowdef/operators/dynamic-fork-task.md
      - devguide/configuration/workflowdef/operators/sub-workflow-task.md
      - devguide/configuration/workflowdef/operators/start-workflow-task.md
      - devguide/configuration/workflowdef/operators/set-variable-task.md
      - devguide/configuration/workflowdef/operators/terminate-task.md
    - Task Definition: devguide/configuration/taskdef.md
    - Event Handlers: devguide/configuration/eventhandlers.md
    - Configuration: devguide/configuration/appconf.md
    - Metrics:
      - Server Metrics: devguide/metrics/server.md
      - Client Metrics: devguide/metrics/client.md
  - Deploy:
    - Docker: devguide/running/deploy.md
    - From Source: devguide/running/source.md
    - Hosted: devguide/running/hosted.md
    - devguide/architecture/index.md
    - Advanced:
      - devguide/advanced/extend.md
      - devguide/advanced/isolationgroups.md
      - devguide/advanced/archival-of-workflows.md
      - devguide/advanced/externalpayloadstorage.md
      - devguide/advanced/redis.md
      - devguide/advanced/postgresql.md
      - devguide/advanced/opensearch.md

theme:
  name: material
  logo: img/logo.svg
  custom_dir: docs/overrides
  palette:
    - scheme: default
      primary: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font: false
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.footer
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/conductor-oss/conductor
    - icon: fontawesome/brands/slack
      link: https://join.slack.com/t/orkes-conductor/shared_invite/zt-3dpcskdyd-W895bJDm8psAV7viYG3jFA
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/@orkesio

extra_css:
  - css/custom.css

plugins:
  - search
  - macros

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

copyright: Conductor authors