mkdocs.yml

docs_dir: '.'  # replace with the correct path if your documentation files are not in the same directory as mkdocs.yml
site_name: Swarms
site_url: https://docs.swarms.world
site_author: Swarms
site_description: The Enterprise-Grade Production-Ready Multi-Agent Orchestration Framework
repo_name: kyegomez/swarms
repo_url: https://github.com/kyegomez/swarms
edit_uri: https://github.com/kyegomez/swarms/tree/main/docs
copyright: TGSC Corp 2024. All rights reserved.

plugins:
  # - glightbox
  - search
  - git-authors
  - mkdocs-jupyter:
        kernel_name: python3
        execute: false
        include_source: True
        include_requirejs: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            parameter_headings: true
            paths: [supervision]
            load_external_modules: true
            allow_inspection: true
            show_bases: true
            group_by_category: true
            docstring_style: google
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_category_heading: true
  - git-committers:
      repository: kyegomez/swarms
      branch: master
      # token: !ENV ["GITHUB_TOKEN"]
  - git-revision-date-localized:
      enable_creation_date: true
extra_css:
  - assets/css/extra.css

extra:
  social:
    - icon: fontawesome/brands/twitter
      link: https://x.com/swarms_corp
    - icon: fontawesome/brands/github
      link: https://github.com/kyegomez/swarms
    - icon: fontawesome/brands/discord
      link: https://discord.gg/EamjgSaEQf
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/@kyegomez3242
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/swarms-corp/

  footer_links:
    
    "Quick Start":
      - title: "Installation"
        url: "https://docs.swarms.world/swarms/install/install/"
      - title: "Quickstart Guide"
        url: "https://docs.swarms.world/quickstart/"
      - title: "Environment Setup"
        url: "https://docs.swarms.world/swarms/install/env/"
      - title: "Basic Agent Example"
        url: "https://docs.swarms.world/swarms/examples/basic_agent/"

    "Core Capabilities":
      - title: "Agents"
        url: "https://docs.swarms.world/swarms/structs/agent/"
      - title: "Multi-Agent Architectures"
        url: "https://docs.swarms.world/swarms/concept/swarm_architectures/"
      - title: "LLM Providers"
        url: "https://docs.swarms.world/swarms/examples/model_providers/"
      - title: "Swarm Router"
        url: "https://docs.swarms.world/swarms/structs/swarm_router/"

    "Advanced Concepts":
      - title: "MAI-DxO (Medical AI Diagnosis)"
        url: "https://github.com/The-Swarm-Corporation/Open-MAI-Dx-Orchestrator"
      - title: "AI-CoScientist Research Framework"
        url: "https://github.com/The-Swarm-Corporation/AI-CoScientist"
      - title: "Agent-as-a-Judge Evaluation"
        url: "https://github.com/kyegomez/swarms/blob/master/examples/single_agent/reasoning_agent_examples/agent_judge_example.py"
      - title: "Research Papers Collection"
        url: "https://github.com/kyegomez/awesome-multi-agent-papers"


    "Tools":
      - title: "Tools and MCP"
        url: "https://docs.swarms.world/swarms/tools/tools_examples/"
      - title: "OpenAI Tools & Function Calling"
        url: "https://docs.swarms.world/swarms/examples/agent_structured_outputs/"
      - title: "Web Search (Exa, Serper)"
        url: "https://docs.swarms.world/swarms_tools/search/"
      - title: "Vision & Image Processing"
        url: "https://docs.swarms.world/swarms/examples/vision_processing/"
      - title: "Browser Automation"
        url: "https://docs.swarms.world/swarms/examples/swarms_of_browser_agents/"
      - title: "Crypto APIs (CoinGecko, HTX)"
        url: "https://docs.swarms.world/swarms/examples/agent_with_tools/"
      - title: "Yahoo Finance"
        url: "https://docs.swarms.world/swarms/examples/yahoo_finance/"

    "Use Cases":
      - title: "Examples Overview"
        url: "https://docs.swarms.world/examples/index/"
      - title: "Templates & Applications"
        url: "https://docs.swarms.world/examples/templates/"
      - title: "Financial Analysis Swarms"
        url: "https://docs.swarms.world/examples/gold_etf_research/"
      - title: "Medical Diagnosis Systems"
        url: "https://docs.swarms.world/examples/aop_medical/"
      - title: "All Examples Repository"
        url: "https://github.com/kyegomez/swarms/tree/master/examples"

  analytics:
    provider: google
    property: G-MPE9C65596

theme:
  name: material
  logo: assets/img/swarms-logo.png
  palette:
    - scheme: default
      primary: white      # White background
      accent: white       # Black accents for interactive elements
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate       # Optional: lighter shades for accessibility
      primary: black
      accent: black
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.tabs
    - navigation.sections
    # - navigation.expand
    - navigation.top
    - navigation.footer
    - announce.dismiss
  font:
    text: "Fira Sans"      # Clean and readable text
    code: "Fira Code"      # Modern look for code snippets


# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.inlinehilite

nav:
  # - Home:
  #   - Overview: "quickstart.md"
  #   - Installation: "swarms/install/install.md"
  #   - Environment Configuration: "swarms/install/env.md"
  #   - Agents: "swarms/agents/index.md"
  #   - Multi-Agent Architectures: "swarms/structs/index.md"

  - Home:
    - Overview: "index.md"
    - Onboarding: 
      - Installation: "swarms/install/install.md"
      - Environment Configuration: "swarms/install/env.md"
      - Quickstart: "quickstart.md"
      - Agents: "swarms/agents/index.md"
      - Multi-Agent Architectures: "swarms/structs/index.md"
    
    - Protocol:
      - Overview: "protocol/overview.md"
      - SIPs: "protocol/sip.md"
      - Feature Set: "swarms/features.md"
      - Swarms Ecosystem: "swarms/ecosystem.md"
      - Technical Support: "swarms/support.md"
    
    
    - Agents:
      - Overview: "swarms/framework/agents_explained.md"
      - Quickstart: "swarms/agents/index.md"
      - Reference: "swarms/structs/agent.md"
      - Fully Autonomous Agent Tutorial: "swarms/examples/autonomous_agent_tutorial.md"
      - Sub-Agent Delegation: "swarms/examples/sub_agent_tutorial.md"
      - Agent Handoffs Tutorial: "swarms/examples/agent_handoff_tutorial.md"
      - Autosave Tutorial: "swarms/examples/autosave_tutorial.md"
      - Tools and MCP: "swarms/tools/tools_examples.md"
      - Agent Memory: "swarms/agents/agent_memory.md"
      - Multi-Agent Helpers: "swarms/structs/agent_multi_agent_communication.md"
      - Agent Skills: "swarms/agents/agent_skills.md"

      - Capabilities:
        - Fallback Models: "swarms/utils/fallback_models.md"
        - Running Agents with YAML: "swarms/agents/create_agents_yaml.md"
        - Tools Reference:
          - Overview: "swarms/tools/main.md"
          - What are tools?: "swarms/tools/build_tool.md"
          - Structured Outputs: "swarms/agents/structured_outputs.md"
          - Agent MCP Integration: "swarms/structs/agent_mcp.md"
        - Long Term Memory Reference:
          - Integrating RAG with Agents: "swarms/memory/diy_memory.md"
        
    - Third-Party Agents:
      - Creating Custom Agents: "swarms/agents/new_agent.md"
      - OpenAI Assistant: "swarms/agents/openai_assistant.md"
      - Integrating External Agents from Griptape, Langchain, etc: "swarms/agents/external_party_agents.md"
    
    - Reasoning Agents:
      - Overview: "swarms/agents/reasoning_agents_overview.md"
      - Self Consistency Agent: "swarms/agents/consistency_agent.md"
      - IRE Agent: "swarms/agents/iterative_agent.md"
      - Reasoning Duo: "swarms/agents/reasoning_duo.md"
      - Reflexion Agent: "swarms/agents/reflexion_agent.md"
      - GKP Agent: "swarms/agents/gkp_agent.md"
      - Agent Judge: "swarms/agents/agent_judge.md"
      - Reasoning Agent Router: "swarms/agents/reasoning_agent_router.md"
    
    - Multi-Agent Architectures:
      - Overview: "swarms/concept/swarm_architectures.md"
      - Benefits: "swarms/concept/why.md"
      - Choosing Multi Agent Architecture: "swarms/concept/how_to_choose_swarms.md"

      - Architecture Reference Docs:
        - Overview: "swarms/structs/overview.md"
        - Custom Multi Agent Architectures: "swarms/structs/custom_swarm.md"
        - Debate Multi-Agent Architectures: "swarms/structs/orchestration_methods.md"

        - Most Used Architectures:
          - SequentialWorkflow: "swarms/structs/sequential_workflow.md"
          - ConcurrentWorkflow: "swarms/structs/concurrentworkflow.md"
          - HierarchicalSwarm: "swarms/structs/hierarchical_swarm.md"
          - PlannerWorkerSwarm: "swarms/structs/planner_worker_swarm.md"
          - GraphWorkflow: "swarms/structs/graph_workflow.md"
          


        - AdvisorSwarm: "swarms/structs/advisor_swarm.md"
        - PlannerGeneratorEvaluator: "swarms/structs/planner_generator_evaluator.md"
        - DebateWithJudge: "swarms/structs/debate_with_judge.md"
        - MajorityVoting: "swarms/structs/majorityvoting.md"
        - MAKER: "swarms/structs/maker.md"
        - RoundRobin: "swarms/structs/round_robin_swarm.md"
        - Mixture of Agents: "swarms/structs/moa.md"
        - SelfMoASeq: "swarms/structs/self_moa_seq.md"
        - SpreadSheetSwarm: "swarms/structs/spreadsheet_swarm.md"
        - ForestSwarm: "swarms/structs/forest_swarm.md"
        - Multi-Agent Execution Utilities: "swarms/structs/various_execution_methods.md"
        - Council of Judges: "swarms/structs/council_of_judges.md"
        - LLM Council: "swarms/structs/llm_council.md"
        - Heavy Swarm: "swarms/structs/heavy_swarm.md"
        - Social Algorithms: "swarms/structs/social_algorithms.md"
        - Overview: "swarms/structs/multi_swarm_orchestration.md"
        - Hierarchical Structured Communication Framework: "swarms/structs/hierarchical_structured_communication_framework.md"
        - Hybrid Hierarchical-Cluster Swarm: "swarms/structs/hhcs.md"
        - Auto Swarm Builder: "swarms/structs/auto_swarm_builder.md"
        - Swarm Matcher: "swarms/structs/swarm_matcher.md"
        - SwarmRouter: "swarms/structs/swarm_router.md"
        - MultiAgentRouter: "swarms/structs/multi_agent_router.md"
        - AgentRouter: "swarms/structs/agent_router.md"
        - ModelRouter: "swarms/structs/model_router.md"
        - SwarmRearrange: "swarms/structs/swarm_rearrange.md"
        - AgentRearrange: "swarms/structs/agent_rearrange.md"
        - GroupChat: "swarms/structs/group_chat.md"
        - BatchedGridWorkflow: "swarms/structs/batched_grid_workflow.md"
        - SkillOrchestra: "swarms/structs/skill_orchestra.md"
        - Communication Structure: "swarms/structs/conversation.md"

    - Utilities:
      - CLI Reference: "swarms/cli/cli_reference.md"
      - Agent Loader: "swarms/utils/agent_loader.md"
      - AgentRegistry: "swarms/structs/agent_registry.md"
      - SubagentRegistry: "swarms/structs/async_subagent.md"

    - Tools:
      - Overview: "swarms_tools/overview.md"
      - BaseTool Reference: "swarms/tools/base_tool.md"
      - MCP Client Utils: "swarms/tools/mcp_client_call.md"
      - Run Bash Tool Tutorial: "examples/autonomous_looper_run_bash_tutorial.md"

      - Vertical Tools:
        - Finance: "swarms_tools/finance.md"
        - Search: "swarms_tools/search.md"
        - Social Media:
          - Twitter: "swarms_tools/twitter.md"


    - Deployment Solutions:
      - Overview: "deployment_solutions/overview.md"
      - FastAPI + Uvicorn: "deployment_solutions/fastapi_agent_api.md"
      - CronJob: "swarms/structs/cron_job.md"
      - Agent on MCP: "examples/mcp_ds.md"
      - Providers:
        - Deploy on Google Cloud Run: "swarms_cloud/cloud_run.md"
        - Deploy on Phala: "swarms_cloud/phala_deploy.md"
        - Deploy on Cloudflare Workers: "swarms_cloud/cloudflare_workers.md"
      - Agent Orchestration Protocol (AOP):
        - AOP Reference: "swarms/structs/aop.md"
        - AOP Server Setup: "swarms/examples/aop_server_example.md"
        - AOP Cluster Example: "swarms/examples/aop_cluster_example.md"

  - Swarms Rust:
    - Overview: "swarms_rs/overview.md"
    - Agents: "swarms_rs/agents.md"

  - Contributors:
    - Overview: "contributors/main.md"
    - Environment Setup: "contributors/environment_setup.md"
    - Bounty Program: "governance/bounty_program.md"
    
    - Development Guides:
      - Code Style Guide & Best Practices: "swarms/framework/code_cleanliness.md"
      - Adding Tests: "swarms/framework/test.md"
      - Adding Documentation: "contributors/docs.md"
      - New Tools & Plugins: "contributors/tools.md"
    
    - Architecture & Design:
      - Understanding Swarms Architecture: "swarms/concept/framework_architecture.md"
      - Development Philosophy & Principles: "swarms/concept/philosophy.md"

    - Changelog:
      - v10: "changelogs/v10.md"