Update icons and cursor rules for Mintlify

VRSEN · Nov 17, 2024 · 3d9cc11 · 3d9cc11
1 parent 54692cd
commit 3d9cc11
Show file tree

Hide file tree

Showing 14 changed files with 333 additions and 1,151 deletions.
diff --git a/docs/advanced-topics/asynchronous-execution.mdx b/docs/advanced-topics/asynchronous-execution.mdx
@@ -1,6 +1,8 @@
-# Asynchronous Execution
-
-Enhance the performance of your agency by running agents and tools asynchronously.
+---
+title: "Asynchronous Execution"
+description: "Enhance the performance of your agency by running agents and tools asynchronously."
+icon: "bolt"
+---
 
 <Tip>
 Asynchronous execution allows agents and tools to operate concurrently, improving overall efficiency.

diff --git a/docs/advanced-topics/customizing-prompts-and-few-shot-learning.mdx b/docs/advanced-topics/customizing-prompts-and-few-shot-learning.mdx
@@ -1,6 +1,7 @@
 ---
-title: 'Customizing Prompts and Few-Shot Learning'
-description: 'Enhance agent behavior by customizing prompts and providing few-shot examples.'
+title: "Customizing Prompts and Few-Shot Learning"
+description: "Fine-tune agent behavior by customizing prompts and providing few-shot examples."
+icon: "magic"
 ---
 
 Fine-tune agent behavior by customizing prompts and providing few-shot examples.

diff --git a/docs/advanced-topics/open-source-models-support.mdx b/docs/advanced-topics/open-source-models-support.mdx
@@ -1,4 +1,8 @@
-# Open-Source Models Support
+---
+title: "Open-Source Models Support"
+description: "Utilize open-source models to provide flexibility and control over your AI agents."
+icon: "code-fork"
+---
 
 While OpenAI models are recommended, Agency Swarm supports open-source models through projects that mimic the Assistants API.
 

diff --git a/docs/advanced-topics/production-readiness.mdx b/docs/advanced-topics/production-readiness.mdx
@@ -1,6 +1,8 @@
-# Production Readiness
-
-Prepare your agency for production by enhancing reliability, scalability, and security.
+---
+title: "Production Readiness"
+description: "Prepare your agency for production by enhancing reliability, scalability, and security."
+icon: "check-circle-o"
+---
 
 <Info>
 Ensuring your agency is production-ready involves careful planning and implementation of best practices.

diff --git a/docs/api-reference/api-reference.mdx b/docs/api-reference/api-reference.mdx
@@ -1,6 +1,7 @@
 ---
-title: 'API Reference'
-description: 'Detailed reference of core classes and methods available in Agency Swarm.'
+title: "API Reference"
+description: "Gain a deeper understanding of the core classes and methods available in Agency Swarm."
+icon: "book"
 ---
 
 ## Agents

diff --git a/docs/contributing/contributing.mdx b/docs/contributing/contributing.mdx
@@ -1,6 +1,6 @@
 ---
-title: 'Contributing to Agency Swarm'
-description: 'Guidelines and steps to contribute to the Agency Swarm project.'
+title: "Contributing to Agency Swarm"
+description: "Learn how to contribute to Agency Swarm"
 ---
 
 We welcome contributions to Agency Swarm! Here's how you can contribute:

diff --git a/docs/examples.mdx b/docs/examples.mdx
@@ -1,6 +1,7 @@
 ---
-title: 'Examples'
-description: 'Practical examples and tutorials to get the most out of Agency Swarm.'
+title: "Examples"
+description: "Explore practical examples and tutorials to get the most out of Agency Swarm."
+icon: "code"
 ---
 
 <Tabs>

diff --git a/docs/faq/faq.mdx b/docs/faq/faq.mdx
@@ -1,4 +1,8 @@
-# FAQ
+---
+title: "FAQ"
+description: "Find answers to common questions about Agency Swarm."
+icon: "question-circle"
+---
 
 Find answers to common questions about Agency Swarm.
 

diff --git a/docs/getting-started/installation.mdx b/docs/getting-started/installation.mdx
@@ -1,11 +1,14 @@
-# Installation
+---
+title: "Installation"
+description: "Instructions on how to install Agency Swarm."
+icon: "download"
+---
 
 Set up Agency Swarm in a few simple steps.
 
-## Requirements
-
-- **Python 3.10-3.12**
-- **pip**
+<Tip>
+    Make sure you have `Python >=3.10 <=3.12` installed on your system before you proceed.
+</Tip>
 
 ## Step-by-Step Installation
 

diff --git a/docs/getting-started/quickstart.mdx b/docs/getting-started/quickstart.mdx
@@ -1,6 +1,7 @@
 ---
-title: 'Quickstart'
-description: 'A guide to quickly get started with Agency Swarm.'
+title: "Quickstart"
+description: "Get started quickly with Agency Swarm."
+icon: "rocket"
 ---
 
 Get up and running with Agency Swarm quickly by following these steps:

diff --git a/docs/how-to-guides/creating-agents.mdx b/docs/how-to-guides/creating-agents.mdx
@@ -1,6 +1,7 @@
 ---
-title: 'Creating Agents'
-description: 'Step-by-step instructions for creating agents in Agency Swarm.'
+title: "Creating Agents"
+description: "Learn how to create custom agents for your agency."
+icon: "user-plus"
 ---
 
 Agents are central to the Agency Swarm framework. Creating custom agents allows you to define specialized roles tailored to specific tasks.
@@ -48,4 +49,4 @@ Agents are central to the Agency Swarm framework. Creating custom agents allows
    ```python
    ceo = CEO()   ```
 
-For more details on defining agent instructions and configurations, refer to the [Defining Agent Instructions](how-to-guides/defining-agent-instructions.md) guide. 
+For more details on defining agent instructions and configurations, refer to the [Defining Agent Instructions](how-to-guides/defining-agent-instructions.md) guide. 
diff --git a/docs/how-to-guides/creating-tools.mdx b/docs/how-to-guides/creating-tools.mdx
@@ -1,6 +1,7 @@
 ---
-title: 'Creating Tools'
-description: 'Learn how to create tools for your agents.'
+title: "Creating Tools"
+description: "Learn how to create custom tools for your agents."
+icon: "wrench"
 ---
 
 Tools are crucial for extending the functionality of agents. They allow agents to perform actions ranging from simple computations to complex API interactions.

diff --git a/docs/introduction/overview.mdx b/docs/introduction/overview.mdx
@@ -1,6 +1,7 @@
 ---
-title: 'Overview'
-description: 'An overview of Agency Swarm and its capabilities.'
+title: "Overview"
+description: "An introduction to Agency Swarm and its capabilities."
+icon: "info-circle"
 ---
 
 Welcome to **Agency Swarm**, an open-source framework for creating and orchestrating multi-agent AI systems.