documentation fix

mkdocs.yml

@@ -16,15 +16,15 @@ extra:
     - icon: fontawesome/brands/python
       link: https://pypi.org/project/Swarms/
 theme:
-  name: material
+    name: material
-  custom_dir: docs/overrides
+    custom_dir: docs/overrides
-  logo: assets/img/SwarmsLogoIcon.png
+    logo: assets/img/SwarmsLogoIcon.png
-  palette:
+    palette:
-    # Palette toggle for light mode
+      # Palette toggle for light mode
     - scheme: default
       primary: black
       toggle:
-        icon: material/brightness-7
+        icon: material/brightness-7 
         name: Switch to dark mode
     # Palette toggle for dark mode
     - scheme: slate
@@ -32,14 +32,14 @@ theme:
       toggle:
         icon: material/brightness-4
         name: Switch to light mode
-  features:
+    features:
-    - content.code.copy
+        - content.code.copy
-    - content.code.annotate
+        - content.code.annotate
-    - navigation.tabs
+        - navigation.tabs
-    - navigation.sections
+        - navigation.sections
-    - navigation.expand
+        - navigation.expand
-    - navigation.top
+        - navigation.top
-    - announce.dismiss
+        - announce.dismiss
 markdown_extensions:
   - pymdownx.highlight:
       anchor_linenums: true
@@ -55,78 +55,77 @@ markdown_extensions:
   - def_list
   - footnotes
 nav:
-  - Home:
+- Home:
-      - Overview: "index.md"
+    - Overview: "index.md"
-      - Contributing: "contributing.md"
+    - Contributing: "contributing.md"
-      - Docker Container Setup: "docker_setup.md"
+    - Docker Container Setup: "docker_setup.md"
-  - Swarms:
+- Swarms:
-      - Overview: "swarms/index.md"
+  - Overview: "swarms/index.md"
   - swarms.swarms:
-      - AbstractSwarm: "swarms/swarms/abstractswarm.md"
+    - AbstractSwarm: "swarms/swarms/abstractswarm.md"
-      - GodMode: "swarms/swarms/godmode.md"
+    - GodMode: "swarms/swarms/godmode.md"
-      - Groupchat: "swarms/swarms/groupchat.md"
+    - Groupchat: "swarms/swarms/groupchat.md"
   - swarms.workers:
-      - Overview: "swarms/workers/index.md"
+    - Overview: "swarms/workers/index.md"
-      - AbstractWorker: "swarms/workers/abstract_worker.md"
+    - AbstractWorker: "swarms/workers/abstract_worker.md"
   - swarms.agents:
-      - AbstractAgent: "swarms/agents/abstract_agent.md"
+    - AbstractAgent: "swarms/agents/abstract_agent.md"
-      - OmniModalAgent: "swarms/agents/omni_agent.md"
+    - OmniModalAgent: "swarms/agents/omni_agent.md"
   - swarms.models:
-      - Language:
+    - Language:  
-          - Overview: "swarms/models/index.md"
+      - Overview: "swarms/models/index.md"
-          - HuggingFaceLLM: "swarms/models/huggingface.md"
+      - HuggingFaceLLM: "swarms/models/huggingface.md"
-          - Anthropic: "swarms/models/anthropic.md"
+      - Anthropic: "swarms/models/anthropic.md"
-          - OpenAI: "swarms/models/openai.md"
+      - OpenAI: "swarms/models/openai.md"
-          - Zephyr: "swarms/models/zephyr.md"
+      - Zephyr: "swarms/models/zephyr.md"
-          - BioGPT: "swarms/models/biogpt.md"
+      - BioGPT: "swarms/models/biogpt.md"
-          - MPT7B: "swarms/models/mpt.md"
+      - MPT7B: "swarms/models/mpt.md"
-          - Mistral: "swarms/models/mistral.md"
+      - Mistral: "swarms/models/mistral.md"
-      - MultiModal:
+    - MultiModal:
-          - Fuyu: "swarms/models/fuyu.md"
+      - Fuyu: "swarms/models/fuyu.md"
-          - Vilt: "swarms/models/vilt.md"
+      - Vilt: "swarms/models/vilt.md"
-          - Idefics: "swarms/models/idefics.md"
+      - Idefics: "swarms/models/idefics.md"
-          - BingChat: "swarms/models/bingchat.md"
+      - BingChat: "swarms/models/bingchat.md"
-          - Kosmos: "swarms/models/kosmos.md"
+      - Kosmos: "swarms/models/kosmos.md"
-          - Nougat: "swarms/models/nougat.md"
+      - Nougat: "swarms/models/nougat.md"
-          - Dalle3: "swarms/models/dalle3.md"
+      - Dalle3: "swarms/models/dalle3.md"
-          - GPT4V: "swarms/models/gpt4v.md"
+      - GPT4V: "swarms/models/gpt4v.md"
-          - LayoutLMDocumentQA: "swarms/models/layoutlm_document_qa.md"
+      - LayoutLMDocumentQA: "swarms/models/layoutlm_document_qa.md"
-          - DistilWhisperModel: "swarms/models/distilled_whisperx.md"
+      - DistilWhisperModel: "swarms/models/distilled_whisperx.md"
-          - ElevenLabsText2SpeechTool: "swarms/models/elevenlabs.md"
+      - ElevenLabsText2SpeechTool: "swarms/models/elevenlabs.md"
   - swarms.structs:
-      - Overview: "swarms/structs/overview.md"
+    - Overview: "swarms/structs/overview.md"
-      - AutoScaler: "swarms/swarms/autoscaler.md"
+    - AutoScaler: "swarms/swarms/autoscaler.md"
-      - Agent: "swarms/structs/agent.md"
+    - Flow: "swarms/structs/flow.md"
-      - SequentialWorkflow: 'swarms/structs/sequential_workflow.md'
+    - SequentialWorkflow: 'swarms/structs/sequential_workflow.md'
   - swarms.memory:
-      - PineconeVectorStoreStore: "swarms/memory/pinecone.md"
+    - PineconeVectorStoreStore: "swarms/memory/pinecone.md"
-      - PGVectorStore: "swarms/memory/pg.md"
+    - PGVectorStore: "swarms/memory/pg.md"
-      - Qdrant: "swarms/memory/qdrant.md"
+- Guides:
-  - Guides:
+    - Overview: "examples/index.md"
-      - Overview: "examples/index.md"
+    - Agents:
-      - Agents:
+      - Flow: "examples/flow.md"
-      - Agent: "examples/agent.md"
       - SequentialWorkflow: "examples/reliable_autonomous_agents.md"
       - OmniAgent: "examples/omni_agent.md"
-      - 2O+ Autonomous Agent Blogs: "examples/ideas.md"
+    - 2O+ Autonomous Agent Blogs: "examples/ideas.md"
-  - Applications:
+- Applications:
-      - CustomerSupport:
+    - CustomerSupport: 
-          - Overview: "applications/customer_support.md"
+      - Overview: "applications/customer_support.md"
-      - Marketing:
+    - Marketing: 
-          - Overview: "applications/marketing_agencies.md"
+      - Overview: "applications/marketing_agencies.md" 
-  - Corporate:
+- Corporate:
-      - FAQ: "corporate/faq.md"
+    - FAQ: "corporate/faq.md"
-      - Purpose: "corporate/purpose.md"
+    - Purpose: "corporate/purpose.md"
-      - Roadmap: "corporate/roadmap.md"
+    - Roadmap: "corporate/roadmap.md"
-      - Weaknesses: "corporate/failures.md"
+    - Weaknesses: "corporate/failures.md"
-      - Design: "corporate/design.md"
+    - Design: "corporate/design.md"
-      - Flywheel: "corporate/flywheel.md"
+    - Flywheel: "corporate/flywheel.md"
-      - Bounties: "corporate/bounties.md"
+    - Bounties: "corporate/bounties.md"
-      - Metric: "corporate/metric.md"
+    - Metric: "corporate/metric.md"
-      - Distribution: "corporate/distribution"
+    - Distribution: "corporate/distribution"
-      - Research: "corporate/research.md"
+    - Research: "corporate/research.md"
-      - Demos: "corporate/demos.md"
+    - Demos: "corporate/demos.md"
-      - Architecture: "corporate/architecture.md"
+    - Architecture: "corporate/architecture.md"
-      - Checklist: "corporate/checklist.md"
+    - Checklist: "corporate/checklist.md"
-      - Hiring: "corporate/hiring.md"
+    - Hiring: "corporate/hiring.md"
-      - SwarmCloud: "corporate/swarm_cloud.md"
+    - SwarmCloud: "corporate/swarm_cloud.md"