Skip to main content

​
Join Our Community

We’re building the future of agentic civilizations, and we need your help! The Swarms API documentation is a community-driven project that thrives on contributions from developers like you.

Documentation Maintenance

Help keep our docs accurate, clear, and up-to-date

Example Development

Create practical examples and tutorials for developers

Client Libraries

Maintain and improve our Python and TypeScript SDKs

Community Support

Help other developers in our Discord and GitHub discussions

​
How to Contribute

​
Getting Started

  1. Fork the repository: swarms-api-docs
  2. Join our Discord: Swarms Discord
  3. Check existing issues: Look for issues labeled good first issue or help wanted
  4. Set up development environment: Follow our development setup guide

​
Development Setup

1

Install Mintlify CLI

npm install -g @mintlify/cli
2

Clone and setup

git clone https://github.com/The-Swarm-Corporation/swarms-api-docs.git
cd swarms-api-docs
3

Start development server

mint dev
4

Open in browser

Navigate to http://localhost:3000 to see your changes

​
Contribution Areas

​
Documentation Maintenance

Help us keep the documentation accurate and comprehensive: What we need help with:
  • Fixing typos and grammatical errors
  • Updating outdated information
  • Improving clarity and readability
  • Adding missing explanations
  • Translating content to other languages
How to contribute:
  1. Look for issues labeled documentation
  2. Create a pull request with your changes
  3. Ensure all changes are tested locally with mint dev
Files to focus on:
  • /getting-started/ - Setup and quickstart guides
  • /capabilities/ - Feature documentation
  • /multi-agent/ - Multi-agent system guides
  • /clients/ - Client library documentation

​
Example Development

Create practical examples that help developers understand the Swarms API: What we need help with:
  • Real-world use case examples
  • Industry-specific implementations
  • Advanced multi-agent workflows
  • Integration examples with popular frameworks
  • Performance optimization examples
Example categories we’re looking for:
  • Healthcare: Patient data analysis, medical research
  • Finance: Risk assessment, fraud detection
  • E-commerce: Product recommendations, customer service
  • Education: Personalized learning, content generation
  • Legal: Document analysis, case research
How to contribute:
  1. Create examples in the /examples/ directory
  2. Include both .mdx documentation and .py code files
  3. Add comprehensive comments and explanations
  4. Test examples with real API calls
Example structure: 
examples/
├── your-example/
│   ├── your-example.mdx
│   ├── your-example.py
│   └── requirements.txt

​
Client Libraries

Help maintain and improve our official client libraries: Python SDK: swarms-client
  • Add new features and endpoints
  • Improve error handling
  • Add type hints and documentation
  • Create comprehensive tests
  • Optimize performance
TypeScript SDK: swarms-ts
  • Implement missing features
  • Add TypeScript definitions
  • Create React/Node.js examples
  • Improve developer experience
How to contribute:
  1. Fork the respective repository
  2. Check existing issues and feature requests
  3. Follow the project’s contribution guidelines
  4. Write tests for new features
  5. Update documentation

​
Community Support

Help other developers succeed with the Swarms API: Ways to help:
  • Answer questions in Discord
  • Respond to GitHub issues and discussions
  • Create tutorial videos or blog posts
  • Share your projects and use cases
  • Provide feedback on new features

​
Contribution Guidelines

​
Code Style

  • Follow existing code patterns and conventions
  • Use clear, descriptive variable and function names
  • Add comments for complex logic
  • Ensure all code is properly formatted

​
Documentation Style

  • Use clear, concise language
  • Include code examples where helpful
  • Follow the existing documentation structure
  • Test all code examples before submitting

​
Pull Request Process

  1. Create a feature branch: git checkout -b feature/your-feature-name
  2. Make your changes: Follow the contribution guidelines
  3. Test locally: Run mint dev to ensure everything works
  4. Commit changes: Use clear, descriptive commit messages
  5. Create pull request: Include a detailed description of your changes
  6. Respond to feedback: Be open to suggestions and improvements

​
Commit Message Format

type(scope): brief description

Detailed explanation of changes (if needed)

Fixes #issue-number
Types:
  • docs: Documentation changes
  • feat: New features
  • fix: Bug fixes
  • example: New examples
  • refactor: Code refactoring
  • test: Adding or updating tests

​
Recognition

We value all contributions to the Swarms ecosystem: Contributor Benefits:
  • Recognition in our contributor hall of fame
  • Early access to new features and APIs
  • Direct communication with the Swarms team
  • Potential opportunities for collaboration
  • Swarms merchandise and swag
Contributor Levels:
  • Community Member: First contribution
  • Active Contributor: 5+ contributions
  • Core Contributor: 20+ contributions or significant impact
  • Maintainer: Long-term commitment and leadership

​
Getting Help

Need help getting started? Have questions about contributing?

​
Current Contributors

We’re grateful to all our contributors who help make the Swarms API documentation better every day.
Want to see your name here? Start contributing today! Every contribution, no matter how small, makes a difference.
Ready to contribute? Fork the repository and join our community today!
⌘I