Skip to content

Commit 7a090a6

Browse files
committed
docs: scaffolding MkDocs documentation site
- Added mkdocs.yml standard config - Generated standard empty file structure for API and Guides - Populated Initial Getting Started guide - Ticked off Documentation Site requirement from ROADMAP.md
1 parent cee1652 commit 7a090a6

9 files changed

Lines changed: 86 additions & 1 deletion

File tree

ROADMAP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@
8484

8585
- [ ] Full test suite (unit + integration + e2e)
8686
- [x] Performance benchmarks (token usage, execution time per scenario) *(tracked in data/benchmarks.json)*
87-
- [ ] Documentation site (guides, API reference, tutorials)
87+
- [x] Documentation site (guides, API reference, tutorials)
8888
- [ ] VS Code extension — visual squad builder
8989
- [ ] Team collaboration — shared squads across users
9090
- [ ] Cloud deployment option (managed service)

docs/api/cli.md

Whitespace-only changes.

docs/api/runner.md

Whitespace-only changes.

docs/guides/architecture.md

Whitespace-only changes.

docs/guides/getting-started.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Getting Started
2+
3+
## Installation
4+
5+
Ensure you have Node.js and Python 3.10+ installed.
6+
7+
1. Clone the repository:
8+
```bash
9+
git clone https://github.com/techwavedev/openminions.git
10+
cd openminions
11+
```
12+
13+
2. Generate your first AI squad via the wizard:
14+
```bash
15+
npx openminions init
16+
```
17+
18+
3. Open the real-time visualizer dashboard:
19+
```bash
20+
npx openminions dashboard
21+
```
22+
23+
## Running a Pipeline
24+
25+
From any project directory integrated with Openminions, simply type:
26+
27+
```bash
28+
npx openminions run --squad data/squads/<squad-name>
29+
```
30+
31+
Your pipeline will execute inside an isolated sandbox, maintaining clean logs and caching to your central vector database.

docs/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# openminions Documentation
2+
3+
Welcome to the **openminions** documentation site. openminions is the next-generation multi-agent orchestrator powered by the `@techwavedev/agi-agent-kit`.
4+
5+
## Overview
6+
7+
Unlike standard multi-agent frameworks that require you to manually wire everything up, openminions utilizes a powerful three-layer architecture:
8+
9+
1. **Directives**: You create your pipeline structure via `squad.json` or interactively via the Architect Wizard.
10+
2. **Orchestration**: The python-based execution engine (`runner.py`) handles memory, checkpoints, and Qdrant integration asynchronously.
11+
3. **Execution**: The React UI serves as a real-time command center, plotting activities geographically on your dashboard through WebSocket sync.
12+
13+
## Navigation
14+
15+
- [Guides](guides/getting-started.md) — Architectural deep-dives and getting started.
16+
- [API Reference](api/cli.md) — Documentation for the openminions CLI and runner APIs.
17+
- [Tutorials](tutorials/first-squad.md) — Step-by-step blueprints for your first orchestrated AI team.

docs/tutorials/dashboard.md

Whitespace-only changes.

docs/tutorials/first-squad.md

Whitespace-only changes.

mkdocs.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
site_name: openminions
2+
site_description: 'Next-generation multi-agent orchestrator powered by agi-agent-kit'
3+
site_author: 'techwavedev'
4+
repo_url: 'https://github.com/techwavedev/openminions'
5+
6+
theme:
7+
name: material
8+
palette:
9+
- media: "(prefers-color-scheme: dark)"
10+
scheme: slate
11+
primary: red
12+
accent: red
13+
features:
14+
- navigation.tabs
15+
- navigation.sections
16+
- toc.integrate
17+
18+
nav:
19+
- Home: index.md
20+
- Guides:
21+
- Getting Started: guides/getting-started.md
22+
- Architecture Overview: guides/architecture.md
23+
- API Reference:
24+
- CLI Reference: api/cli.md
25+
- Runner API: api/runner.md
26+
- Tutorials:
27+
- Building your first Squad: tutorials/first-squad.md
28+
- Setting up the UI: tutorials/dashboard.md
29+
30+
markdown_extensions:
31+
- pymdownx.highlight:
32+
anchor_linenums: true
33+
- pymdownx.inlinehilite
34+
- pymdownx.snippets
35+
- admonition
36+
- pymdownx.details
37+
- pymdownx.superfences

0 commit comments

Comments
 (0)