Skip to content

Commit 0baf25e

Browse files
author
loong-solvable
committed
docs: add documentation entry pages
1 parent 73b60f2 commit 0baf25e

2 files changed

Lines changed: 31 additions & 0 deletions

File tree

docs/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Swarms Documentation
2+
3+
Swarms is a framework for building and orchestrating production multi-agent systems.
4+
5+
Use this documentation to find installation notes, agent guides, orchestration patterns, examples, tooling references, and contributor information.
6+
7+
## Start Here
8+
9+
- Quickstart: see the quickstart guide.
10+
- Agents: see the agent overview.
11+
- Multi-agent architectures: see the orchestration overview.
12+
- Contributors: see the contributor guide.

docs/quickstart.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Quickstart
2+
3+
This quickstart points new readers to the main onboarding paths in the documentation.
4+
5+
## Install
6+
7+
Start with the installation guide in the Swarms onboarding section.
8+
9+
## Build An Agent
10+
11+
Read the agents overview, then choose a basic agent example that matches your use case.
12+
13+
## Choose An Architecture
14+
15+
For multi-agent systems, review the architecture overview and the guide for choosing a swarm pattern.
16+
17+
## Explore Examples
18+
19+
The examples section contains practical agent, workflow, tool, and deployment walkthroughs.

0 commit comments

Comments
 (0)