Docs

CROWDio Documentation Site

This repository contains the full documentation for the CROWDio distributed compute framework, published via MkDocs Material and deployed to GitHub Pages.

---

Documentation Sections

Section	Contents
Getting Started	Prerequisites, install, environment setup
Quick Start	Run Foreman + Worker + Client in 5 minutes
Architecture	Component diagrams, data flow, state machines, protocol
SDK Guide	connect, map, run, submit, get, pipeline with full examples
Checkpointing	Decorator API, checkpoint payload, recovery flow
Operations	Scheduler config, monitoring endpoints, DB management
API Reference	All REST endpoints and WebSocket message types
Mobile Worker	Android build, setup, Chaquopy Python layer
Evaluation	Metrics API, benchmarking experiment modules

---

Build the Docs Locally

# Install doc dependencies
pip install -r docs-requirements.txt

# Serve with live-reload
mkdocs serve

# Open http://127.0.0.1:8000

Build Static Site

mkdocs build
# Output is in site/

---

Deployment (GitHub Pages)

Docs are automatically built and deployed when commits are pushed to main via:

.github/workflows/deploy-docs.yml

To configure GitHub Pages:

1. Go to repository Settings → Pages.
2. Set Source to GitHub Actions.
3. Push to main — the workflow will build and publish the site.

---

Adding Images

All image placeholders are documented in:

docs/assets/images/README.md

Replace placeholder comments in the markdown files with real images once available.

---

Adding Report Content

Additional content from the project report can be inserted into:

• docs/architecture/overview.md — for background and motivation.
• docs/evaluation/experiments.md — for full results tables and graphs.
• Any page using the <!-- PLACEHOLDER ... --> comment convention.

---

File Structure

Docs/
├── mkdocs.yml                         # MkDocs config and nav
├── docs-requirements.txt              # Python build dependencies
├── .github/
│   └── workflows/
│       └── deploy-docs.yml            # GitHub Pages deploy workflow
└── docs/
    ├── index.md                       # Home page
    ├── getting-started.md
    ├── quick-start.md
    ├── stylesheets/
    │   └── extra.css
    ├── assets/
    │   └── images/
    │       └── README.md              # Image placeholder guide
    ├── architecture/
    │   ├── overview.md
    │   ├── backend.md
    │   ├── mobile-worker.md
    │   └── protocol.md
    ├── sdk/
    │   ├── guide.md
    │   └── checkpointing.md
    ├── operations/
    │   ├── scheduler.md
    │   ├── monitoring.md
    │   └── troubleshooting.md
    ├── api/
    │   ├── rest.md
    │   └── websocket.md
    ├── mobile/
    │   ├── android-worker.md
    │   ├── python-layer.md
    │   └── build-run.md
    └── evaluation/
        └── experiments.md