AeroStream Documentation Portal

This repository houses the official technical documentation and architecture whitepapers for AeroStream, built with Material for MkDocs.

Live Documentation: aerostream.gradientgeeks.com/docs

---

Local Development & Live Preview

Run the documentation server locally with live reload:

# Using uv (recommended, zero-install)
uvx --with mkdocs-material mkdocs serve

# Or using standard pip
pip install -r requirements.txt
mkdocs serve

Then navigate to http://127.0.0.1:8000 in your browser.

---

Directory Structure

.
├── mkdocs.yml              # MkDocs Material configuration & navigation
├── requirements.txt        # Python build dependencies
└── docs/
    ├── index.md            # Platform overview & quickstart
    ├── architecture.md     # Dual-engine architecture deep dive
    ├── benchmarks.md       # OpenMessaging Benchmark (OMB) verified results
    ├── kafka-protocol.md   # Kafka wire protocol compatibility (port 9092)
    ├── sdks.md             # Native client SDKs (Go, Rust, Java, .NET, Node.js)
    ├── schema-registry.md  # Confluent-compatible Schema Registry
    ├── transforms.md       # In-broker stream transforms & WASM engine
    ├── tiered-storage.md   # Multi-cloud tiered storage (S3, MinIO, GCS, Azure)
    ├── security-rbac.md    # RBAC, ACLs, SASL & zero-trust security
    ├── operations.md       # Kubernetes, production sizing, and cluster tuning
    ├── cla.md              # Contributor License Agreement
    ├── diagrams/           # Excalidraw source files & vector SVGs
    ├── images/             # Rendered architecture graphics & assets
    └── javascripts/        # MathJax and custom scripts

---

Contributing

We welcome contributions to AeroStream documentation! Please see CONTRIBUTING.md and review our Contributor License Agreement (CLA) before opening pull requests.