Welcome to the comprehensive documentation hub for Orbit-RS, a high-performance distributed virtual actor system framework written in Rust.
docs/
├── README.md # This file
├── ../specifications/PRD.md # Product Requirements Document
├── index.md # Documentation site index
├── overview.md # Project overview
├── project_overview.md # Detailed project overview
├── quick_start.md # Quick start guide
├── features.md # Feature documentation
├── status.md # Project status
├── contributing.md # Contributing guide
│
├── content/ # Core documentation content
│ ├── protocols/ # Protocol implementations
│ ├── storage/ # Storage engine docs
│ ├── server/ # Server configuration docs
│ ├── graph/ # Graph database docs
│ ├── graph-rag/ # GraphRAG documentation
│ ├── geo/ # Geospatial docs
│ ├── ai/ # AI/ML features
│ ├── ml/ # Machine learning docs
│ ├── gpu-compute/ # GPU acceleration
│ ├── architecture/ # Architecture docs
│ ├── operations/ # Operations guides
│ ├── deployment/ # Deployment guides
│ ├── development/ # Development resources
│ │ ├── github/ # GitHub templates
│ │ ├── guidelines/ # Coding standards
│ │ ├── issues/ # Issue tracking
│ │ ├── testing/ # Test coverage
│ │ ├── verification/ # Verification scripts
│ │ └── wip/ # Work-in-progress
│ ├── rfcs/ # RFC documents
│ ├── legal/ # Legal documents
│ ├── desktop/ # Desktop client docs
│ ├── examples/ # Code examples
│ ├── support/ # Support resources
│ └── *.md # Feature documentation files
│
├── planning/ # Project planning
│ ├── backlog/ # Feature backlog items
│ ├── competitive/ # Competitive analysis
│ ├── features/ # Planned features
│ ├── phases/ # Implementation phases
│ └── roadmap/ # Strategic roadmap
│
├── archive/ # Archived documentation
└── assets/ # Static assets
- Project Overview - Comprehensive project overview with verified metrics and architecture
- Quick Start Guide - Get up and running in minutes
- Development Guide - Complete setup and development instructions
- Contributing Guide - How to contribute to the project
- Virtual Actor Persistence - Actor state persistence, activation, and lifecycle management
- Storage Backend Independence - Cloud vs local storage architecture
- Transaction Features - Distributed transactions, locks, saga patterns, and security
- Protocol Adapters - Redis, PostgreSQL, and MCP protocol support
- Network Layer - gRPC services, Protocol Buffers, and communication
- Cluster Management - Node discovery, load balancing, and fault tolerance
- Graph Database - Complete graph operations and Cypher-like queries
- Graph Commands - Graph database command reference
- Vector Operations - AI/ML vector database capabilities
- Time Series Commands - Time-series data management and analytics
- OrbitQL Documentation - Unified multi-model query language
- AQL Reference - ArangoDB Query Language compatibility
- Kubernetes Deployment - Production Kubernetes deployment and persistence
- CI/CD Pipeline - Continuous integration and deployment
- Deployment Guide - Deployment configurations and guides
- Strategic Roadmap - Comprehensive development roadmap and future plans
- Feature Backlog - Complete feature backlog with priorities and timelines
- Planning Documents - Detailed planning and phase documentation
- Development Resources - Guidelines, testing, and verification
- GitHub Project - Live project tracking with issues
- GPU Acceleration - CUDA, Metal, Vulkan GPU compute
- GraphRAG - Graph-based retrieval augmented generation
- Query Languages Comparison - SQL, Cypher, AQL, and OrbitQL comparison
- LSM Tree Implementation - Custom storage engine implementation
- AI/ML Features - Machine learning and AI capabilities
- Security Documentation - Security policies and vulnerability reporting
- Secrets Configuration - Secure configuration management
- Contributing Guide - How to contribute to the project
- Changelog - Version history and release notes
- RFC Documents - Request for Comments and architectural decisions
- API Documentation - Generated API documentation
- Start with the Project Overview to understand Orbit-RS capabilities and verified metrics
- Follow the Quick Start Guide to get a working system
- Explore Advanced Transaction Features for distributed capabilities
- Review Protocol Support to understand multi-model database features
- Review the Strategic Roadmap to understand current production-ready status
- Check Kubernetes Complete Documentation for production setup
- Review CI/CD Pipeline for deployment automation
- Explore Advanced Transaction Features for enterprise features
- Read the Development Guide for setup and guidelines
- Check the Feature Backlog for prioritized features and timelines
- Review the Strategic Roadmap for long-term development plans
- Browse the GitHub Issues for specific tasks
- Review Security Documentation for security and compliance
- Check Advanced Transaction Features for enterprise capabilities
- Browse the Planning Documents for migration and implementation guides
- Contact Enterprise Support for professional services
- GitHub Repository - Source code and issues
- GitHub Project - Development roadmap tracking
- API Documentation - Generated API documentation
- Contributing Guide - How to contribute
- Issue Tracker - Bug reports and feature requests
- Discussions - Community discussions and Q&A
- Project Documentation: All overview, status, and structure documents merged into comprehensive Project Overview
- Strategic Planning: All roadmap documents unified into planning/
- Feature Planning: All backlog documents consolidated into planning/backlog/
- Development Resources: Guidelines, testing, and WIP docs organized in development/
- Core Content: Protocol, storage, and feature docs organized in content/
- Folder Structure: Reorganized into 3 main categories: content, development, planning
- Total Documents: 100+ comprehensive markdown files
- Lines of Documentation: 30,000+ lines of technical documentation
- Verified Metrics: All project statistics audited and verified (November 2025)
- Cross-References: 200+ internal links verified and updated
- Update Frequency: Monthly review and quarterly major updates
- Last Reorganization: November 2025
- Community Input: Open documentation improvement process
- Version Control: All changes tracked in Git with detailed commit messages
Orbit-RS: Production-ready multi-model distributed database platform Documentation: Comprehensive, accurate, and continuously maintained Happy building with Orbit-RS!