Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Documentation for Agency-Swarm #188

Open
wants to merge 44 commits into
base: main
Choose a base branch
from

Conversation

bonk1t
Copy link
Collaborator

@bonk1t bonk1t commented Nov 19, 2024

Summary

This PR introduces a comprehensive documentation update using Mintlify, focusing on improved user experience and scalability. The new structure provides clear pathways for both beginners and advanced users while maintaining extensibility for future growth.

Key Changes

  1. New Documentation Platform

    • Migrated to Mintlify with an intuitive navigation structure
    • Implemented dark/light mode support and improved searchability
  2. Enhanced Content Structure

    • Organized into clear sections: Get Started, Core Framework, and Advanced Topics
    • Added comprehensive API reference and contribution guidelines
    • Included practical tutorials and examples for common use cases
  3. Improved Guides

    • Detailed instructions for creating agents, tools, and agencies
    • Advanced topics covering communication flows, state management, and production deployment
    • Framework comparison with AutoGen and CrewAI

The new documentation structure can be found in the mint.json configuration file.

@bonk1t bonk1t marked this pull request as ready for review November 20, 2024 04:24
@bonk1t bonk1t changed the title Add Mintlify docs New Documentation for Agency-Swarm Nov 22, 2024
@bonk1t bonk1t requested a review from VRSEN November 22, 2024 00:52
class MyCustomTool(BaseTool):
"""
A brief description of what the custom tool does.
A brief description of what the custom tool does.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A repeat of the previous line

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants