# MarlOS Documentation Index

## Getting Started

| Guide | Description |
|---|---|
| [Local Testing](LOCAL_TESTING.md) | Run demos, benchmarks, and tests on one machine |
| [CLI Guide](CLI_GUIDE.md) | All `marl` commands with examples |
| [Quick Start](QUICKSTART.md) | 5-minute manual setup |
| [pip Installation](PIP_INSTALL.md) | Install with pip |
| [PATH Setup](PATH_SETUP_QUICK_REFERENCE.md) | Fix "command not found" |

## Deployment

| Guide | Description |
|---|---|
| [Deployment Guide](DEPLOYMENT.md) | Single node, Docker, LAN, cloud, worldwide |
| [Lab Setup](LAB_SETUP.md) | Step-by-step: 5+ machines on same network |
| [Distributed Deployment](DISTRIBUTED_DEPLOYMENT.md) | Real device deployment (detailed) |
| [Network Modes](USER_GUIDE_NETWORK_MODES.md) | Private vs Public mode |

## API & Integration

| Guide | Description |
|---|---|
| [API Guide](API_GUIDE.md) | REST API, MCP server, JavaScript SDK, pipelines, groups |
| [Plugin System](PLUGINS.md) | Write a custom runner in 5 minutes |
| [JS SDK](../sdk/js/README.md) | JavaScript/TypeScript client library |

## Architecture

| Guide | Description |
|---|---|
| [RL Architecture](ARCHITECTURE_RL.md) | 25D state vector, PPO training, fairness metrics |
| [Token Economy](ARCHITECTURE_TOKEN.md) | MarlCredits, taxation, UBI, Gini monitoring |
| [Economic Whitepaper](ECONOMIC_WHITEPAPER.md) | Formal model with simulation results |
| [Network Design](NETWORK_DESIGN.md) | P2P protocol, ZMQ, Ed25519, DHT |
| [Checkpoint & Recovery](CHECKPOINT_RECOVERY_GUIDE.md) | Fault tolerance, job migration |
| [Predictive System](RL_PREDICTION_DESIGN.md) | Speculative pre-execution |

## Configuration

| Guide | Description |
|---|---|
| [Config Architecture](CONFIG_ARCHITECTURE.md) | 3-tier config system |
| [Full Config Reference](FULL_CONFIG_USAGE.md) | All parameters |
| [Config Management](CONFIG_MANAGEMENT_GUIDE.md) | Create, edit, delete node configs |
| [Predictive Config](PREDICTIVE_CONFIG.md) | Prediction/speculation settings |

## Other

| Guide | Description |
|---|---|
| [Interactive Installer](INSTALL.md) | Guided setup wizard |
| [Share Guide](SHARE.md) | Share MarlOS with your team |
| [Contributing](../CONTRIBUTING.md) | How to contribute |
| [Changelog](../CHANGELOG.md) | Version history |

---

**Version**: 1.1.0 | **Last Updated**: March 2026
