Skip to main content
This site is built with Mintlify and lives in a separate repository from the main Swarms Python package. If you want to fix typos, add guides, update API pages, or improve navigation, you contribute here.

Documentation repository

The-Swarm-Corporation/swarms-framework-docs on GitHub

​
What belongs in this repo

Use swarms-framework-docs for:
  • MDX pages (guides, concepts, examples, community, API reference content)
  • docs.json (site name, theme, navigation, tabs)
  • Images and static assets referenced from the docs
For Python library code, tests, and in-repo docs/, follow Contributing to Swarms and the main framework repository linked from GitHub.

​
Quick start: edit on GitHub

  1. Open the repository and browse to the file (for example under concepts/, agents/, or community/).
  2. Click the pencil icon Edit this file.
  3. Commit to a new branch and open a pull request.
Small fixes (wording, broken links, frontmatter) are ideal for this flow.

​
Local preview

For larger edits, preview the site before you open a PR.
  1. Fork and clone the docs repo: 
    git clone https://github.com/YOUR_USERNAME/swarms-framework-docs.git
cd swarms-framework-docs
    Add the upstream remote if you plan to sync often: 
    git remote add upstream https://github.com/The-Swarm-Corporation/swarms-framework-docs.git
  2. Install the Mintlify CLI (requires Node.js): 
    npm i -g mint
  3. Run the dev server from the repository root (where docs.json lives): 
    mint dev
  4. Open http://localhost:3000 and verify your changes.
If the CLI is outdated or something fails to start, run mint update and try again.

​
Project layout

PathRole
docs.jsonSite config: theme, colors, navbar, navigation (which MDX files appear in each tab)
*.mdx at repo rootTop-level pages (for example introduction, quickstart)
Folders (agents/, concepts/, api/, …)Grouped MDX pages; paths match entries in docs.json without the .mdx extension
AGENTS.mdNotes for humans and AI assistants working in this repo
When you add a new page, create the MDX file and register it under the right navigation.tabs[].groups[].pages entry in docs.json, otherwise it will not appear in the sidebar.

​
Writing conventions

These align with the repo’s CONTRIBUTING.md and AGENTS.md:
  • Use active voice and address the reader as you.
  • Keep sentences short; one idea per sentence.
  • Start procedural sections with the outcome the reader wants.
  • Use sentence case for headings unless a product name requires otherwise.
  • Bold UI labels when describing clicks: Settings, Submit.
  • Use code formatting for commands, file paths, and identifiers.
Prefer Mintlify components (for example Card, Note, Warning, AccordionGroup) when they improve scanning; match patterns used on neighboring pages.

​
Before you open a pull request

  • Confirm new or moved pages are wired in docs.json.
  • Run link checks from the repo root: 
    mint broken-links
  • Keep the change focused (one topic or fix per PR when possible) so review stays fast.

​
Conduct and help

  • Follow the Code of Conduct.
  • Questions about Swarms usage are a better fit for Discord or FAQ; use GitHub issues on the docs repo for site bugs or clear documentation gaps.

Thank you

Improvements to this documentation help every Swarms user. We appreciate your contributions.