From 1160ca006e774f2d8663cc208bf31a6890ac5a5c Mon Sep 17 00:00:00 2001 From: Nick Bobrowski <39348559+bonk1t@users.noreply.github.com> Date: Wed, 20 Nov 2024 05:02:45 +0000 Subject: [PATCH] Minor fixes --- .../advanced-communication-flows.mdx | 2 +- ...tomizing-prompts-and-few-shot-learning.mdx | 2 +- .../advanced-topics/production-readiness.mdx | 18 ++--- docs_new/extras/extras.mdx | 39 +++++++++++ docs_new/faq/faq.mdx | 6 +- .../communication-flows.mdx | 2 +- .../managing-communication-flows.mdx | 2 +- docs_new/mint.json | 20 +++++- docs_new/tutorials/tutorials.mdx | 67 +++++++++++++++++++ 9 files changed, 138 insertions(+), 20 deletions(-) create mode 100644 docs_new/extras/extras.mdx create mode 100644 docs_new/tutorials/tutorials.mdx diff --git a/docs_new/advanced-topics/advanced-communication-flows.mdx b/docs_new/advanced-topics/advanced-communication-flows.mdx index d839e232..97a6a611 100644 --- a/docs_new/advanced-topics/advanced-communication-flows.mdx +++ b/docs_new/advanced-topics/advanced-communication-flows.mdx @@ -1,7 +1,7 @@ --- title: "Advanced Communication Flows" description: "Learn how to customize communication flows for your agency." -icon: "message" +icon: "comments" --- Multi-agent communication is the core functionality of any Multi-Agent System. Unlike in all other frameworks, Agency Swarm not only allows you to define communication flows in any way you want (uniform communication flows), but to also configure the underlying logic for this feature. This means that you can create entirely new types of communication, or adjust it to your own needs. Below you will find a guide on how to do all this, along with some common examples. diff --git a/docs_new/advanced-topics/customizing-prompts-and-few-shot-learning.mdx b/docs_new/advanced-topics/customizing-prompts-and-few-shot-learning.mdx index 03b0bc3c..b03a5b0a 100644 --- a/docs_new/advanced-topics/customizing-prompts-and-few-shot-learning.mdx +++ b/docs_new/advanced-topics/customizing-prompts-and-few-shot-learning.mdx @@ -1,7 +1,7 @@ --- title: "Customizing Prompts and Few-Shot Learning" description: "Fine-tune agent behavior by customizing prompts and providing few-shot examples." -icon: "magic" +icon: "gear" --- Fine-tune agent behavior by customizing prompts and providing few-shot examples. diff --git a/docs_new/advanced-topics/production-readiness.mdx b/docs_new/advanced-topics/production-readiness.mdx index 39437821..d37c2bae 100644 --- a/docs_new/advanced-topics/production-readiness.mdx +++ b/docs_new/advanced-topics/production-readiness.mdx @@ -1,7 +1,7 @@ --- title: "Production Readiness" description: "Prepare your agency for production by enhancing reliability, scalability, and security." -icon: "check-circle-o" +icon: "check" --- @@ -10,9 +10,9 @@ Ensuring your agency is production-ready involves careful planning and implement ## Key Considerations - + - + Implement comprehensive error handling within agents and tools to gracefully handle unexpected issues. @@ -20,7 +20,7 @@ Use try-except blocks and logging to capture and manage exceptions. - + Secure API keys, enforce access controls, and sanitize inputs to protect against vulnerabilities. @@ -28,12 +28,12 @@ Never hard-code API keys or sensitive information in your code. - + Use monitoring tools to track performance and detect anomalies. Maintain logs for auditing and debugging. - + Design for horizontal scaling to handle increased loads efficiently. @@ -46,11 +46,7 @@ Consider using cloud services that support auto-scaling features. ## Best Practices - - **Testing**: Thoroughly test agents and tools under various conditions, including edge cases. - - **Documentation**: Maintain clear documentation for maintenance and onboarding of new team members. - - **Continuous Integration/Continuous Deployment (CI/CD)**: Set up pipelines for automated testing and deployment to streamline updates. - - \ No newline at end of file + diff --git a/docs_new/extras/extras.mdx b/docs_new/extras/extras.mdx new file mode 100644 index 00000000..b8dd47d7 --- /dev/null +++ b/docs_new/extras/extras.mdx @@ -0,0 +1,39 @@ +--- +title: Agency Swarm Extras +description: Additional resources and repositories for Agency Swarm. +icon: plus-circle +--- + +Explore additional repositories to enhance your Agency Swarm experience. + + + + Experiment with the latest features in Agency Swarm Lab. + + + + Deploy your agency using the API Railway Template. + + + + Integrate voice commands with the Agency Voice Interface. + + diff --git a/docs_new/faq/faq.mdx b/docs_new/faq/faq.mdx index 354c8e13..0e318231 100644 --- a/docs_new/faq/faq.mdx +++ b/docs_new/faq/faq.mdx @@ -6,9 +6,9 @@ icon: "question" Find answers to common questions about Agency Swarm. - + - + **A**: Agency Swarm is an open-source framework designed to facilitate the creation and orchestration of multi-agent AI systems. @@ -22,7 +22,7 @@ pip install agency-swarm - + **A**: Yes, you can integrate open-source models or custom language models that mimic the OpenAI Assistants API. diff --git a/docs_new/framework-overview/communication-flows.mdx b/docs_new/framework-overview/communication-flows.mdx index 255ac6a2..7350406a 100644 --- a/docs_new/framework-overview/communication-flows.mdx +++ b/docs_new/framework-overview/communication-flows.mdx @@ -1,7 +1,7 @@ --- title: "Communication Flows" description: "Learn how to define communication flows for your agency." -icon: "message" +icon: "comments" --- Communication flows in Agency Swarm are flexible and user-defined. Unlike other frameworks, they are **not strictly hierarchical** or **sequential**. Communication permissions are established from left to right inside the `agency_chart`. diff --git a/docs_new/how-to-guides/managing-communication-flows.mdx b/docs_new/how-to-guides/managing-communication-flows.mdx index 34eb4d14..7774a292 100644 --- a/docs_new/how-to-guides/managing-communication-flows.mdx +++ b/docs_new/how-to-guides/managing-communication-flows.mdx @@ -1,7 +1,7 @@ --- title: "Managing Communication Flows" description: "Learn how to define custom communication flows for your agency." -icon: "message" +icon: "comments" --- Effective communication between agents is essential for collaboration. Agency Swarm allows you to define custom communication flows. diff --git a/docs_new/mint.json b/docs_new/mint.json index c35ad87a..981b4ce5 100644 --- a/docs_new/mint.json +++ b/docs_new/mint.json @@ -37,8 +37,12 @@ }, "tabs": [ { - "name": "Examples", - "url": "examples" + "name": "Tutorials", + "url": "tutorials" + }, + { + "name": "Extras", + "url": "extras" } ], "anchors": [ @@ -123,6 +127,18 @@ "pages": [ "faq/faq" ] + }, + { + "group": "Tutorials", + "pages": [ + "tutorials/tutorials" + ] + }, + { + "group": "Extras", + "pages": [ + "extras/extras" + ] } ], "search": { diff --git a/docs_new/tutorials/tutorials.mdx b/docs_new/tutorials/tutorials.mdx new file mode 100644 index 00000000..1cd5cbf3 --- /dev/null +++ b/docs_new/tutorials/tutorials.mdx @@ -0,0 +1,67 @@ +--- +title: "Agency Swarm Tutorials" +description: "A collection of tutorials showing how to use the Agency Swarm framework to automate workflows." +icon: "rocket-launch" +--- + + + + This video provides a practical guide to deploying AI agents in production using a free deployment template. It covers cloud, serverless, and hybrid options. + + + + Learn to create AI agent teams using a Cursor template. This tutorial walks you through building a content creation agency with step-by-step instructions. + + + + Explore advanced techniques in the Agency Swarm framework, including asynchronous modes, parallel tool calling, and open API schema conversion. + + + + Guide on deploying your agency to a production environment. + + + + Strategies for managing agent communication flows. + + + + Explore advanced features and best practices. + +