[DOCS]

docs/mkdocs.yml

@@ -112,7 +112,7 @@ nav:
       - Workflows: "swarms/structs/workflows.md"
       - Multi-Agent Architectures: "swarms/structs/multi_agent_architectures.md"
   - Reference:
-      - Overview: "swarms/framework_structure.md"
+      - Overview: "swarms/framework/reference.md.md"
       - Models:
           - How to Create A Custom Language Model: "swarms/models/custom_model.md"
           - Models Available: "swarms/models/index.md"

docs/swarms/framework/index.md

@@ -0,0 +1,127 @@
+## Swarms Framework Conceptual Breakdown
+
+The `swarms` framework is a sophisticated structure designed to orchestrate the collaborative work of multiple agents in a hierarchical manner. This breakdown provides a conceptual and visual representation of the framework, highlighting the interactions between models, tools, memory, agents, and swarms.
+
+### Hierarchical Structure
+
+The framework can be visualized as a multi-layered hierarchy:
+
+1. **Models, Tools, Memory**: These form the foundational components that agents utilize to perform tasks.
+2. **Agents**: Individual entities that encapsulate specific functionalities, utilizing models, tools, and memory.
+3. **Swarm**: A collection of multiple agents working together in a coordinated manner.
+4. **Structs**: High-level structures that organize and manage swarms, enabling complex workflows and interactions.
+
+### Visual Representation
+
+Below are visual graphs illustrating the hierarchical and tree structure of the `swarms` framework.
+
+#### 1. Foundational Components: Models, Tools, Memory
+
+```mermaid
+graph TD;
+    Models --> Agents
+    Tools --> Agents
+    Memory --> Agents
+    subgraph Foundational_Components
+        Models
+        Tools
+        Memory
+    end
+```
+
+#### 2. Agents and Their Interactions
+
+```mermaid
+graph TD;
+    Agents --> Swarm
+    subgraph Agents_Collection
+        Agent1
+        Agent2
+        Agent3
+    end
+    subgraph Individual_Agents
+        Agent1 --> Models
+        Agent1 --> Tools
+        Agent1 --> Memory
+        Agent2 --> Models
+        Agent2 --> Tools
+        Agent2 --> Memory
+        Agent3 --> Models
+        Agent3 --> Tools
+        Agent3 --> Memory
+    end
+```
+
+#### 3. Multiple Agents Form a Swarm
+
+```mermaid
+graph TD;
+    Swarm1 --> Struct
+    Swarm2 --> Struct
+    Swarm3 --> Struct
+    subgraph Swarms_Collection
+        Swarm1
+        Swarm2
+        Swarm3
+    end
+    subgraph Individual_Swarms
+        Swarm1 --> Agent1
+        Swarm1 --> Agent2
+        Swarm1 --> Agent3
+        Swarm2 --> Agent4
+        Swarm2 --> Agent5
+        Swarm2 --> Agent6
+        Swarm3 --> Agent7
+        Swarm3 --> Agent8
+        Swarm3 --> Agent9
+    end
+```
+
+#### 4. Structs Organizing Multiple Swarms
+
+```mermaid
+graph TD;
+    Struct --> Swarms_Collection
+    subgraph High_Level_Structs
+        Struct1
+        Struct2
+        Struct3
+    end
+    subgraph Struct1
+        Swarm1
+        Swarm2
+    end
+    subgraph Struct2
+        Swarm3
+    end
+    subgraph Struct3
+        Swarm4
+        Swarm5
+    end
+```
+
+### Directory Breakdown
+
+The directory structure of the `swarms` framework is organized to support its hierarchical architecture:
+
+```sh
+swarms/
+├── agents/
+├── artifacts/
+├── marketplace/
+├── memory/
+├── models/
+├── prompts/
+├── schemas/
+├── structs/
+├── telemetry/
+├── tools/
+├── utils/
+└── __init__.py
+```
+
+### Summary
+
+The `swarms` framework is designed to facilitate complex multi-agent interactions through a structured and layered approach. By leveraging foundational components like models, tools, and memory, individual agents are empowered to perform specialized tasks. These agents are then coordinated within swarms to achieve collective goals, and swarms are managed within high-level structs to orchestrate sophisticated workflows.
+
+This hierarchical design ensures scalability, flexibility, and robustness, making the `swarms` framework a powerful tool for various applications in AI, data analysis, optimization, and beyond.