mkdocs.yml

site_name: versionHQ
site_author: Version IO Sdn. Bhd.
site_description: Documentation | Agentic orchestration framework for multi-agent networks and task graph for complex task automation
# site_url: https://docs.versi0n.io/
repo_url: https://github.com/versionhq/multi-agent-system/
repo_name: multi-agent-system
edit_uri: edit/main/docs/
use_directory_urls: false
copyright: Copyright © 2024-2025 Version IO Sdn. Bhd.
markdown_extensions:
  - abbr
  - admonition
  - pymdownx.details
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
  - pymdownx.tilde
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
theme:
  name: material
  language: en
  favicon: _logos/favicon.ico
  logo: _logos/logo192.png
  font:
    code: Roboto Mono
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye
    admonition:
      note: octicons/light-bulb-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
  features:
    # - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - content.tooltips
    - header.autohide
    - navigation.tabs
    - navigation.path
    - navigation.expand
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.instant.prefetch
    - navigation.tracking
    - toc.follow
    - toc.integrate
    - search.suggest
    - search.highlight
    - search.share
nav:
  - Home: 'index.md'
  - Quick Start: 'quickstart.md'
  - Agent Network:
    - 'core/agent-network/index.md'
    - Generating: 'core/agent-network/form.md'
    - Configuring: 'core/agent-network/config.md'
    - Agent:
      - 'core/agent/index.md'
      - Configuration: 'core/agent/config.md'
      - Task Handling: 'core/agent/task-handling.md'
    - LLM:
      - 'core/llm/index.md'
    - Reference: 'core/agent-network/ref.md'
  - Task Graph:
    - 'core/task-graph/index.md'
    - Task:
      - 'core/task/index.md'
      - Structuring Response:
        - Concept: 'core/task/task-strc-response.md'
        - ResponseField: 'core/task/response-field.md'
      - Executing: 'core/task/task-execution.md'
      - Outputs: 'core/task/task-output.md'
      - Evaluating: 'core/task/evaluation.md'
      - Reference: 'core/task/reference.md'
  - Components:
    - Tool: 'core/tool.md'
    - RAG Tool: core/rag-tool.md
    - Memory: core/memory.md
    - Knowledge: core/knowledge.md
  - Archive: 'tags.md'
  - Cases:
    - Playground: https://versionhq.vercel.app/playground
    - Experiment - Agent Performance: https://github.com/versionHQ/exp-agent-performance
  - Change Log: https://github.com/versionHQ/multi-agent-system/releases

extra_css:
  - stylesheets/main.css

plugins:
  # - social
  - search
  - tags:
      tags: true

extra:
  analytics:
    provider: google
    property: G-E19K228ENL
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by using our <a href="https://github.com/versionhq/multi-agent-system/issues/new/?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">feedback form</a>.
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/versionHQ/multi-agent-system
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/versionhq/?viewAsMember=true